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

AVEVA™ Plant SCADA

ITrendCursor​.PenLabelX [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Get or Set the label's X-Axis position of the specified pen on this cursor.

Defined As

  • [VBA] Double PenLabelX(pen As Object)

  • [Cicode] REAL PenLabelX (OBJECT pen)

  • [C++] HRESULT PenLabelX (IPen* pen, double labelX)

Parameters

pen

[in] The pen for which cursor label is to be referenced.

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 label position is represented in pixels.

Calling Syntax

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

[VBA]

Sub Example(cursor As Object, pen As Object)
Dim labelX As Double
`Getting Property value
labelX = cursor.PenLabelX(pen)
`Setting Property value (100)
cursor.PenLabelX(pen) = 100
End Sub

[Cicode]

FUNCTION Example(OBJECT hCursor, OBJECT hPen)
REAL labelX;
// Getting current property value
labelX = _ObjectCallMethod(hCursor , "get_PenLabelX", hPen);
// Setting Property to 100
_ObjectCallMethod(hCursor , "put_PenLabelX", hPen, 100);
END

See Also

ITrendCursor.PenLabelWidth [Property][Get/Set]

ITrendCursor.PenLabelHeight [Property][Get/Set]

ITrendCursor.PenLabelY [Property][Get/Set]

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