AGI UI PluginsSend comments on this topic.
OnInitializeToolbar Method (IAgUiPlugin)
See Also
ToolbarBuilder
The toolbar builder provided by the hosting environment. OnInitializeToolbar method is called by the hosting environment when the User Interface plugin is loaded and is never called after that.
Windows





Windows & Linux

Description

Allows the UI plugin to configure a custom toolbar.

Syntax

[Visual Basic .NET]
Public Sub OnInitializeToolbar( _
    ByVal ToolbarBuilder As IAgUiPluginToolbarBuilder _
)
[C#]
public void OnInitializeToolbar(
    IAgUiPluginToolbarBuilder ToolbarBuilder
);
[Managed C++]
public: void OnInitializeToolbar(
    IAgUiPluginToolbarBuilder ^ ToolbarBuilder
);
[Unmanaged C++]
public: HRESULT OnInitializeToolbar(
    IAgUiPluginToolbarBuilder * ToolbarBuilder
);
[Java]
public void onInitializeToolbar(
    IAgUiPluginToolbarBuilder ToolbarBuilder
);

Parameters

ToolbarBuilder
The toolbar builder provided by the hosting environment. OnInitializeToolbar method is called by the hosting environment when the User Interface plugin is loaded and is never called after that.

See Also

Example

The example demonstrates how to add a custom button and associate it with a named command.
Add a button to a custom toolbar.
void IAgUiPlugin.OnInitializeToolbar(IAgUiPluginToolbarBuilder ToolbarBuilder)
{
    //Add a Toolbar Button
    ToolbarBuilder.AddButton("MyFirstCommand", "Example CSharp Ui Plugin Toolbar Button", "Open a Custom user interface.", AgEToolBarButtonOptions.eToolBarButtonOptionAlwaysOn, null);
}
© 2025 Analytical Graphics, Inc. All Rights Reserved.