Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

IPen​.HorizontalAxisColor [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or sets the color used to draw the line, labels, and interval markers of the horizontal axis of this pen.

Defined As

  • [VBA] Long HorizontalAxisColor

  • [Cicode] INT HorizontalAxisColor

  • [C++] OLE_COLOR HorizontalAxisColor

Execution Result

If the property get/set succeeds, the return value will be Success. If the return variable is bad, the return value will be InvalidArgument. If the pen is deleted, 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.HorizontalAxisColor
`Setting Property value to Red
pen.HorizontalAxisColor = 255
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, "HorizontalAxisColor");
// Setting Property to Red
_ObjectSetProperty(hPen, "HorizontalAxisColor", PackedRGB(255, 0, 0));
END

See Also

IPen.VerticalAxisColor [Property][Get/Set]

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in