Toolbar Class

In This Topic

Class for modifying Toolbars.

Inheritance Hierarchy

System.Object
Eplan.EplApi.Gui.Toolbar

Syntax

C#
C++/CLI

public class Toolbar

public ref class Toolbar

Remarks

Please mind, that for creating and removing tool bars and buttons, the main frame is needed to be visible. This means, it is not possible to create a tool bar in OnInitGui() of the IEplAddin interface, when EPLAN is just starting. Please handle the Eplan.EplApi.OnMainStart event instead to create the tool bar. The First time, you load the Add-In via GUI, you should create the tool bar in OnRegister() of the IEplAddin interface. In QuietMode, no tool bars can be created. If the action of the button does not exist, button is removed automatically from custom toolbar. Toolbar without any button is removed automatically. Mind, that the tool bar is not automatically stored in the workspace.

Public Constructors

	Name	Description
	Toolbar Constructor	Creates a new object.

Top

Public Methods

	Name	Description
	AddButton	Overloaded. add a new button to the custom toolbar
	CreateCustomToolbar	creates a user toolbar
	Dispose	Destructor for deterministic finalization of Toolbar object.
	ExistsToolbar	returns true when this toolbar exists
	GetButtonAction	returns the action for a button in this toolbar. When this button has a persistent button id, the buton has no Action but simple the persistent id. When this is a button added by the customer, the action is not empty.
	GetButtonToolTip	Returns the tooltip from the button
	GetCountOfButtons	returns the count of elements of this toolbar. Toolbar can contain two kinds of elements: buttons and separators.
	GetPersistentButtonId	returns the persistent command id for a button in this toolbar. The persistent id does not change from one start of P8 to the other.
	RemoveButton	Remove a button or separator of the custom toolbar
	RemoveCustomToolbar	Remove the complete custom toolbar
	SetButtonToolTip	Sets the tooltip of the button.

Top

Reference

Toolbar Members
Eplan.EplApi.Gui Namespace

Send Feedback