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

AVEVA™ Plant SCADA

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

  • Last UpdatedJul 18, 2023
  • 1 minute read

Get or set whether this pen will be visually shown (True) or hidden (False) to the operator.

Defined As

  • [VBA] Boolean Visible

  • [Cicode] INT Visible

  • [C++] VARIANT_BOOL Visible

Execution Result

If the property get 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): Visible

  • False (0): Hidden

Calling Syntax

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

[VBA]

Sub Example(pen As Object)
Dim visible As Boolean
`Get the property value
visible = pen.Visible
` Set the property value
pen.Visible = False
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT bVisible;
// Get the property value
bVisible = _ObjectGetProperty(hPen, "Visible", 0.5);
// Set the property value
_ObjectSetProperty(hPen, "Visible", 0);
END

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