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

AVEVA™ Plant SCADA

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

  • Last UpdatedJul 18, 2023
  • 1 minute read

Get or Set the physical height in pixels that the pen will allocate for itself when displayed in Stacked mode.

Defined As

  • [VBA] Integer Height

  • [Cicode] INT Height

  • [C++] double Height

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 height set is out of range (16 - 1000), the return value will be InvalidArgument. If the pen is deleted, the return value will be GeneralFailure.

Remarks

This property is ignored when the pen is not in Stacked mode.

Calling Syntax

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

[VBA]

Sub Example(pen As Object)
Dim height As Boolean
`Getting Property value
height = pen.Height
`Setting Property value
pen.Height = 75
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT height;
// Getting current property value
height = _ObjectGetProperty(hPen, "Height");
// Setting Property
_ObjectSetProperty(hPen, "Height", 75);
END

See Also

IPen.Stacked [Property][Get/Set]

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