Class DisplayCommandGroupEventArgs
Provides data for the DisplayCommandGroup event
Namespace: ABB.Robotics.RobotStudio.Environment
Assembly: ABB.Robotics.RobotStudio.Environment.dll
Syntax
public class DisplayCommandGroupEventArgs : EventArgs
Properties
Id
ID of the corresponding CommandBarButtonGroup
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
String |
Remarks
This is provided for convenience; it is also reachable by casting the sender argument of the event handler to CommandBarButtonGroup
QueryEnabled
If true, this event is raised to query if the group has any enabled items. It is enough to add a single item to indicate the state of the group. This is used to increase the performance when displaying the popup menu that contains the group.
Declaration
public bool QueryEnabled { get; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
AddHeader(String)
Adds a header to the command group.
Declaration
public void AddHeader(string caption)
Parameters
Type | Name | Description |
---|---|---|
String | caption | Header text |
AddHeader(String, CommandBarHeaderStyles)
Adds a header to the command group.
Declaration
public void AddHeader(string caption, CommandBarHeaderStyles headerStyles)
Parameters
Type | Name | Description |
---|---|---|
String | caption | Header text |
CommandBarHeaderStyles | headerStyles | Header styles |
AddItem(CommandBarButton)
Adds an existing button to the command group.
Declaration
public void AddItem(CommandBarButton button)
Parameters
Type | Name | Description |
---|---|---|
CommandBarButton | button |
Remarks
If HandleButtons is false, UpdateCommandUI and ExecuteCommand events will be raised by the button object. Otherwise, the ExecuteCommand event will be raised by the group object.
AddItem(CommandBarButton, String)
Adds an existing button to the command group.
Declaration
public void AddItem(CommandBarButton button, string caption)
Parameters
Type | Name | Description |
---|---|---|
CommandBarButton | button | |
String | caption | Override the button caption |
Remarks
If HandleButtons is false, UpdateCommandUI and ExecuteCommand events will be raised by the button object. Otherwise, the ExecuteCommand event will be raised by the group object.
AddItem(CommandBarPopup)
Adds an existing CommandBarPopup to the command group.
Declaration
public void AddItem(CommandBarPopup popup)
Parameters
Type | Name | Description |
---|---|---|
CommandBarPopup | popup |
AddItem(CommandBarPopup, String)
Adds an existing CommandBarPopup to the command group.
Declaration
public void AddItem(CommandBarPopup popup, string caption)
Parameters
Type | Name | Description |
---|---|---|
CommandBarPopup | popup | |
String | caption | Override the popup caption |
AddItem(String, Boolean, Boolean)
Adds a menu item to the command group
Declaration
public void AddItem(string caption, bool isChecked, bool isEnabled)
Parameters
Type | Name | Description |
---|---|---|
String | caption | |
Boolean | isChecked | |
Boolean | isEnabled |
AddItem(String, Object)
Adds a menu item to the command group
Declaration
public void AddItem(string caption, object tag)
Parameters
Type | Name | Description |
---|---|---|
String | caption | |
Object | tag |
AddItem(String, Object, Boolean)
Adds a menu item to the command group
Declaration
public void AddItem(string caption, object tag, bool isChecked)
Parameters
Type | Name | Description |
---|---|---|
String | caption | |
Object | tag | |
Boolean | isChecked |
AddItem(String, Object, Image)
Adds a menu item to the command group
Declaration
public void AddItem(string caption, object tag, Image image)
Parameters
Type | Name | Description |
---|---|---|
String | caption | |
Object | tag | |
Image | image |
AddItem(String, Object, Image, Boolean)
Adds a menu item to the command group
Declaration
public void AddItem(string caption, object tag, Image image, bool isChecked)
Parameters
Type | Name | Description |
---|---|---|
String | caption | |
Object | tag | |
Image | image | |
Boolean | isChecked |
AddItem(String, Object, Image, Boolean, Boolean)
Adds a menu item to the command group
Declaration
public void AddItem(string caption, object tag, Image image, bool isChecked, bool isEnabled)
Parameters
Type | Name | Description |
---|---|---|
String | caption | |
Object | tag | |
Image | image | |
Boolean | isChecked | |
Boolean | isEnabled |
AddItem(String, Object, Image, Boolean, Boolean, String)
Adds a menu item to the command group
Declaration
public void AddItem(string caption, object tag, Image image, bool isChecked, bool isEnabled, string helpText)
Parameters
Type | Name | Description |
---|---|---|
String | caption | |
Object | tag | |
Image | image | |
Boolean | isChecked | |
Boolean | isEnabled | |
String | helpText |
AddSeparator()
Adds a separator to the command group
Declaration
public void AddSeparator()