ITrendCursor.Color [Property][Get/Set]

Gets or Sets the line color of the cursor.

Defined As

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

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 cursor is deleted the return value will be GeneralFailure.

Remarks

The Cicode function PackedRGB can be used to convert an RGB color specification to the OLE_COLOR type used by the Process Analyst.

Calling Syntax

This example assumes you have a valid reference to a cursor.

[VBA]

Sub Example(cursor As Object)

	Dim trendCursorColor As Long

	`Getting Property value

   trendCursorColor = cursor.Color

   `Setting Property value (to red)

  cursor.Color = 255

End Sub

[Cicode]

FUNCTION Example(OBJECT hCursor)

   INT trendCursorColor;

	 // Getting current property value

 trendCursorColor = _ObjectGetProperty(hCursor, "Color");

  // Setting Property to blue

	 _ObjectSetProperty(hCursor, "Color", PackedRGB(0, 0, 255));

END