Class RibbonTab
Represents a single tab in the Ribbon
Namespace: ABB.Robotics.RobotStudio.Environment
Assembly: ABB.Robotics.RobotStudio.Environment.dll
Syntax
public class RibbonTab
Constructors
RibbonTab(String)
Creates a new RibbonTab with the given ID
Declaration
public RibbonTab(string id)
Parameters
Type | Name | Description |
---|---|---|
String | id |
RibbonTab(String, String)
Creates a new RibbonTab with the given ID and caption
Declaration
public RibbonTab(string id, string caption)
Parameters
Type | Name | Description |
---|---|---|
String | id | |
String | caption |
Properties
Caption
Gets or sets the caption text for this tab
Declaration
public string Caption { get; set; }
Property Value
Type | Description |
---|---|
String |
Flash
Sets or gets if the tab should flash to alert the user
Declaration
public bool Flash { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
GroupCompactingOrder
Returns a collection of RibbonGroups defining the order in which groups should be compacted
Declaration
public RibbonGroupCollection GroupCompactingOrder { get; }
Property Value
Type | Description |
---|---|
RibbonGroupCollection |
Remarks
As each group can have four defined sizes (Large, Medium, Small, Compacted), each group may occur up to three times in the collection.
Groups
Returns the collection of RibbonGroups building up this tab
Declaration
public RibbonGroupCollection Groups { get; }
Property Value
Type | Description |
---|---|
RibbonGroupCollection |
Id
Returns the unique ID of this tab
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
String |
Visible
Sets or gets if the tab should be visible or not
Declaration
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
GetKeyTip(CommandBarControl)
Returns the keytip used for a CommandBarControl on this tab
Declaration
public string GetKeyTip(CommandBarControl control)
Parameters
Type | Name | Description |
---|---|---|
CommandBarControl | control |
Returns
Type | Description |
---|---|
String |
SetKeyTip(CommandBarControl, String)
Sets the keytip to be used for a CommandBarControl on this tab
Declaration
public void SetKeyTip(CommandBarControl control, string keyTip)
Parameters
Type | Name | Description |
---|---|---|
CommandBarControl | control | |
String | keyTip |
SimulateClick(String)
Simulates a user clicking on a control on the ribbon.
Declaration
public void SimulateClick(string controlId)
Parameters
Type | Name | Description |
---|---|---|
String | controlId |