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

AVEVA™ Plant SCADA

IToolbarButtons​.Remove [Method]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Removes a button from this toolbar at the supplied index.

Defined As

  • [VBA] Remove(Index as Integer)

  • [Cicode] Remove (INT Index)

  • [C++] HRESULT Remove (int Index)

Parameters

Index

[in] The index of the button to remove from this toolbar. (1 Based)

Execution Results

If the method succeeds, the return value will be Success. If the index is out of range, the return value will be InvalidRange. If the method does not succeed, the return value will be GeneralFailure.

Calling Syntax

This example assumes there is a valid ToolbarButtons collection as retrieved from an ObjectView. (for example, VBA: objectView.Toolbars.Item(1).Buttons).

[VBA]

Sub Example(Buttons As Object)
Buttons.Remove(1)
End Sub

[Cicode]

FUNCTION Example(OBJECT hButtons)
_ObjectCallMethod(hButtons, "Remove", 1);
END

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