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

AVEVA™ Plant SCADA

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

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or Sets whether the sample points are displayed or hidden on the pen.

Defined As

  • [VBA] Boolean PointsVisible

  • [Cicode] INT PointsVisible

  • [C++] VARIANT_BOOL PointsVisible

Execution Results

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): Points are visible

  • False(0): Points are hidden

Remarks

By default this property is False, meaning that any point type you have set using the SetQualityCompactionPointType function will be hidden.

Calling Syntax

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

[VBA]

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

[Cicode]

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

See Also

IPen.SetQualityCompactionPointType [Method]

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