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

AVEVA™ Plant SCADA

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

  • Last UpdatedJul 18, 2023
  • 1 minute read

Get or Set whether the pen is visually displayed stacked or overlaid.

Defined As

  • [VBA] Boolean Stacked

  • [Cicode] INT Stacked

  • [C++] VARIANT_BOOL Stacked

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.

Limits

  • True (-1): Stacked

  • False (0): Overlaid

Remarks

When stacked, pens will be drawn under each other; when overlaid, the pens will be drawn over the top of each other.

Calling Syntax

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

[VBA]

Sub Example(pen As Object)
Dim stacked As Boolean
`Getting Property value
stacked = pen.Stacked
`Setting Property value
pen.Stacked = True
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT bStacked;
// Getting current property value
bStacked = _ObjectGetProperty(hPen, "Stacked");
// Setting property value
_ObjectSetProperty(hPen, "Stacked", -1);
END

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