Class RibbonGroup
Corresponds to a control group in a Ribbon tab
Implements
Namespace: ABB.Robotics.RobotStudio.Environment
Assembly: ABB.Robotics.RobotStudio.Environment.dll
Syntax
public class RibbonGroup : ICommandBarControlContainer
Constructors
RibbonGroup(String, String)
Creates a new RibbonGroup
Declaration
public RibbonGroup(string id, string caption)
Parameters
Type | Name | Description |
---|---|---|
String | id | Unique ID (within the tab) of the group |
String | caption | Group caption |
Properties
Button
Corresponds to an optional button placed in the group header to the right
Declaration
public CommandBarButton Button { get; set; }
Property Value
Type | Description |
---|---|
CommandBarButton |
Caption
Gets or sets the group caption
Declaration
public string Caption { get; set; }
Property Value
Type | Description |
---|---|
String |
Controls
Returns the collection of contained CommandBarControls
Declaration
public CommandBarControlCollection Controls { get; }
Property Value
Type | Description |
---|---|
CommandBarControlCollection |
Id
Returns the ID of the group
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
String |
Remarks
The ID is unique within the tab that contains this group
Image
Gets or sets the image that is displayed when the group is collapsed
Declaration
public Image Image { get; set; }
Property Value
Type | Description |
---|---|
Image |
LargeImage
Gets or sets the image that is displayed when the group is collapsed on a high-DPI display
Declaration
public Image LargeImage { get; set; }
Property Value
Type | Description |
---|---|
Image |
LargeThemedImage
Gets the group's large image, recolored for use in the ribbon according to the current theme.
Declaration
public Image LargeThemedImage { get; }
Property Value
Type | Description |
---|---|
Image |
Remarks
This is automatically generated from LargeImage if it meets certain criteria; otherwise LargeImage is returned.
ThemedImage
Gets the group's image, recolored for use in the ribbon according to the current theme.
Declaration
public Image ThemedImage { get; }
Property Value
Type | Description |
---|---|
Image |
Remarks
This is automatically generated from Image if it meets certain criteria; otherwise Image is returned.
Methods
GetControlLayout(CommandBarControl)
Returns the layout and size of a contained control for the three group sizes
Declaration
public RibbonControlLayout[] GetControlLayout(CommandBarControl control)
Parameters
Type | Name | Description |
---|---|---|
CommandBarControl | control |
Returns
Type | Description |
---|---|
RibbonControlLayout[] |
GetControlVisibility(CommandBarControl)
Returns the visibility of a contained control for the three group sizes
Declaration
public bool[] GetControlVisibility(CommandBarControl control)
Parameters
Type | Name | Description |
---|---|---|
CommandBarControl | control |
Returns
Type | Description |
---|---|
Boolean[] |
SetControlLayout(CommandBarControl, RibbonControlLayout[])
Sets the layout and size of a contained control for the three group sizes
Declaration
public void SetControlLayout(CommandBarControl control, params RibbonControlLayout[] layouts)
Parameters
Type | Name | Description |
---|---|---|
CommandBarControl | control | |
RibbonControlLayout[] | layouts |
SetControlVisibility(CommandBarControl, Boolean[])
Sets the visibility of a contained control for the three group sizes
Declaration
public void SetControlVisibility(CommandBarControl control, bool[] visibility)
Parameters
Type | Name | Description |
---|---|---|
CommandBarControl | control | The CommandBarControl to set the visibility for |
Boolean[] | visibility | Array of three bools defining the visibility for the three size configurations |
Remarks
This method is primarily intended to set the visibility of separators.