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

AVEVA™ Plant SCADA

IObjectViewPenItem​.Checked [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Gets or Sets whether or not this pen item is checked.

Defined As

  • [VBA] Boolean Checked

  • [Cicode] INT Checked

  • [C++] VARIANT_BOOL Checked

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): Checked

  • False (0): Unchecked

Remarks

This reflects the pens visibility property directly, and any sets to this property will reflect immediately in the update of the Process Analyst display.

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 checked As Boolean
`Getting Property value
checked = objectViewPenItem.Checked
`Setting Property value
objectViewPenItem.Checked = False
End Sub

[Cicode]

FUNCTION Example(OBJECT hObjectViewPenItem)
// Getting property value
INT checked = _ObjectGetProperty(hObjectViewItem, "Checked");
// Setting property value
_ObjectSetProperty(hObjectViewItem, "Checked", 0);
END

See Also

OVItemChecked [Event]

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