Chat Support
Loupe - Log - Monitor - Resolve
Loupe.Extensibility.Client Namespace / IUserInterfaceContext Interface / RegisterCommand Method / RegisterCommand(String,Boolean,String,String,String,Icon) Method
The unique name of the command within the calling Extension
Indicates if the command will provide its own user interface or not.
The default end-user display label in menus and lists
Optional. An extended tooltip for this command
Optional. A group of commands of the same extension. A divider will be displayed between groups
Optional. An icon to be displayed for the command

In This Topic
    RegisterCommand(String,Boolean,String,String,String,Icon) Method
    In This Topic
    Registers an add-in command.
    Syntax
    'Declaration
     
    
    Overloads Sub RegisterCommand( _
       ByVal name As String, _
       ByVal isUserInteractive As Boolean, _
       ByVal label As String, _
       ByVal toolTip As String, _
       ByVal group As String, _
       ByVal icon As Icon _
    ) 

    Parameters

    name
    The unique name of the command within the calling Extension
    isUserInteractive
    Indicates if the command will provide its own user interface or not.
    label
    The default end-user display label in menus and lists
    toolTip
    Optional. An extended tooltip for this command
    group
    Optional. A group of commands of the same extension. A divider will be displayed between groups
    icon
    Optional. An icon to be displayed for the command
    Remarks

    Register commands in the order you want them to be listed in menus or offered in lists.

    Individual commands can be enabled and disabled prior to display. All possible unique commands should be registered.

    If isUserInteractive is false then the main UI will provide an asynchronous execution user interface. Otherwise, the command will be called from the main UI thread and will be expected to provide a responsive user experience.

    Use group names to organize your menu items. A divider will automatically be placed in menus between groups and menu items will be sorted first by group order then item order. All items with a null or empty group name will be placed together.

    To create hierarchal menus use periods in the name field and backslashes in the label to create levels. Items with the same name at a given tier will be merged. This means the name top.middle.bottom will result in the command being placed in a sub menu "middle" of the sub menu "top". To have better labels the label can be "This is the Top\This is the Middle\This is the bottom"

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also