IPen.TrendCursorLabelTextColor [Property][Get/Set]

Gets or sets the text color used for any cursor label associated with this pen.

Defined As

• [VBA] Long TrendCursorLabelTextColor
• [Cicode] INT TrendCursorLabelTextColor
• [C++] OLE_COLOR TrendCursorLabelTextColor

Execution Result

If the property get/set succeeds the return value will be Success. If the return variable is bad then the return value will be InvalidArgument. If the pen is deleted then the return value will be GeneralFailure.

Remarks

To calculate the integer value necessary for a color apply the following formula (65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255.

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)

 Dim color As Long

 `Getting Property value

   color = pen.TrendCursorLabelTextColor

	 `Setting Property value to Red

	pen.TrendCursorLabelTextColor = 255

End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)

	INT color;

		// Getting current property value

 color = _ObjectGetProperty(hPen, "TrendCursorLabelTextColor");

	// Setting Property to Red

		_ObjectSetProperty(hPen, "TrendCursorLabelTextColor", PackedRGB(255, 0, 0));

END