STK UI Plugins	Send comments on this topic.
AddButton Method (IAgUiPluginToolbarBuilder)
See Also

CommandID: A named command.

Title: A text associated with the command. The text will be displayed in a tool tip.

Description: A text displayed in the status bar when a mouse is over the button.

Options

PictureDisp: An icon associated with the toolbar button. Can be null. If no icon is specified, the button will display the text specified by the Title parameter.

Description

Adds a standard push-style button.

Note: Toolbar changes may not be immediately reflected in STK. To force a toolbar reset, go to Edit > Preferences > UI Plugins. Select the current plugin, then click "Reset Toolbars."

Syntax

[Visual Basic .NET]
Public Sub AddButton( _ ByVal CommandID As String, _ ByVal Title As String, _ ByVal Description As String, _ ByVal Options As AgEToolBarButtonOptions, _ ByVal PictureDisp As Picture _ )

[Visual Basic .NET]

Public Sub AddButton( _
    ByVal CommandID As String, _
    ByVal Title As String, _
    ByVal Description As String, _
    ByVal Options As AgEToolBarButtonOptions, _
    ByVal PictureDisp As Picture _
)

[C#]
public void AddButton( string CommandID, string Title, string Description, AgEToolBarButtonOptions Options, System.Drawing.Image PictureDisp );

[C#]

public void AddButton(
    string CommandID,
    string Title,
    string Description,
    AgEToolBarButtonOptions Options,
    System.Drawing.Image PictureDisp
);

[Managed C++]
public: void AddButton( String __gc ^ CommandID, String __gc ^ Title, String __gc ^ Description, AgEToolBarButtonOptions Options, stdole::IPictureDisp ^ PictureDisp );

[Managed C++]

public: void AddButton(
    String __gc ^ CommandID,
    String __gc ^ Title,
    String __gc ^ Description,
    AgEToolBarButtonOptions Options,
    stdole::IPictureDisp ^ PictureDisp
);

[Unmanaged C++]
public: HRESULT AddButton( BSTR CommandID, BSTR Title, BSTR Description, AgEToolBarButtonOptions Options, stdole::IPictureDisp * PictureDisp );

[Unmanaged C++]

public: HRESULT AddButton(
    BSTR CommandID,
    BSTR Title,
    BSTR Description,
    AgEToolBarButtonOptions Options,
    stdole::IPictureDisp * PictureDisp
);

[Java]
public void addButton( String CommandID, String Title, String Description, AgEToolBarButtonOptions Options, Picture PictureDisp );

[Java]

public void addButton(
    String CommandID,
    String Title,
    String Description,
    AgEToolBarButtonOptions Options,
    Picture PictureDisp
);

Parameters

CommandID: A named command.
Title: A text associated with the command. The text will be displayed in a tool tip.
Description: A text displayed in the status bar when a mouse is over the button.
Options
PictureDisp: An icon associated with the toolbar button. Can be null. If no icon is specified, the button will display the text specified by the Title parameter.

Description

Syntax

Parameters

See Also