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

AVEVA™ Plant SCADA

IObjectViewPenItem​.Selected [Property][Get]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets whether or not this pen is the selected pen in its pane.

Defined As

  • [VBA] Boolean Selected

  • [Cicode] INT Selected

  • [C++] VARIANT_BOOL Selected

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.

Limits

  • True (-1): Selected

  • False (0): Unselected

Remarks

Each Pane has one selected pen. It is visually emphasized by a vertical gradient fill.

Calling Syntax

This example assumes there is a valid pen item as retrieved from an ObjectView. (for example, VBA: objectView.Items.Item(1).Items.Item(1) This will be a pen).

[VBA]

Sub Example(objectViewPenItem As Object)
Dim selected As Boolean
`Getting Property value
selected = objectViewPenItem.Selected
End Sub

[Cicode]

FUNCTION Example(OBJECT hObjectViewPenItem)
// Getting property value
INT selected = _ObjectGetProperty(hObjectViewItem, "Selected");
END

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