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

AVEVA™ Plant SCADA

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

  • Last UpdatedFeb 27, 2024
  • 1 minute read

Gets and Sets this Toolbars Visible state.

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.

Limits

  • True (-1): Visible

  • False (0): Invisible

Remarks

Both the main and navigation toolbars can be hidden.

If a toolbar is not visible, the buttons tied to it will not appear.

Note: The navigation toolbar is automatically hidden when the chart contains no pens. Changing the value of this properly while there are no pens will not have an effect until a pen is added.

Calling Syntax

This example assumes there is a valid Toolbar object as retrieved from a Process Analyst's Toolbars collection. (for example, VBA: ProcessAnalyst.Toolbars.Item(1))

[VBA]

Sub Example(Toolbar As Object)
Dim visible As Boolean
`Getting Property value
visible = Command.Visible
`Setting Property value
Command.Visible = False
End Sub

[Cicode]

FUNCTION Example(OBJECT hToolbar)
// Getting property value
INT nVisible = _ObjectGetProperty(hToolbar, "Visible");
// Setting property value
_ObjectSetProperty(hToolbar, "Visible", 0);
END

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