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

AVEVA™ Plant SCADA

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

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or sets a unit type which can be applied to the axis labels. This allows numbers on the axis to display with their unit. For example, setting the unit to "kg" will display "10 Kg" on the axis.

Defined As

  • [VBA] Integer VerticalAxisLabelType

  • [Cicode] INT VerticalAxisLabelType

  • [C++] AxisLabelType VerticalAxisLabelType

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

Label Types are fixed and cannot be added to.

Calling Syntax

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

[VBA]

Sub Example(pen As Object)
Dim labelType As Integer
`Getting Property value
labelType = pen.VerticalAxisLabelType
`Setting Property value to Percent
pen.VerticalAxisLabelType= 3
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT labelType;
// Getting current property value
labelType = _ObjectGetProperty(hPen, "VerticalAxisLabelType");
// Setting Property to Percent
_ObjectSetProperty(hPen, "VerticalAxisLabelType", 3);
END

See Also

AxisLabelType [Enumeration]

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