Radio |
Represents a group of related buttons in the Ribbon.
Inheritance Hierarchy Namespace: Autodesk.Revit.UI
Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax The RadioButtonGroup type exposes the following members.
Properties | Name | Description | |
|---|---|---|
 | Current | Gets or sets the current checked ToggleButton of the RadioButtonGroup. |
| | Enabled | Gets or sets a value indicating whether the item is enabled. (Inherited from RibbonItem ) |
| | ItemText | Gets or sets the text displayed on the item. (Inherited from RibbonItem ) |
| | ItemType | Gets the item type. (Inherited from RibbonItem ) |
| | LongDescription | Long description of the command tooltip (Inherited from RibbonItem ) |
| | Name | The name of the item. (Inherited from RibbonItem ) |
| | ToolTip | The description that appears as a ToolTip for the item. (Inherited from RibbonItem ) |
| | ToolTipImage | The image to show as a part of the button extended tooltip (Inherited from RibbonItem ) |
| | Visible | Gets or sets a value indicating whether the item is visible. (Inherited from RibbonItem ) |
Methods | Name | Description | |
|---|---|---|
 | AddItem | Adds a new ToggleButton to the RadioButtonGroup. |
| | AddItems | Adds new ToggleButtons to the RadioButtonGroup. |
| | Equals | Determines whether the specified Object is equal to the current Object . (Inherited from RibbonItem ) |
| | GetContextualHelp | Gets the contextual help bound with this control. (Inherited from RibbonItem ) |
| | GetHashCode | Serves as the default hash function. (Inherited from Object ) |
| | GetItems | Gets the collection of ToggleButtons assigned to the RadioButtonGroup. |
| | GetType | Gets the Type of the current instance. (Inherited from Object ) |
| | SetContextualHelp | Sets the contextual help bound with this button. (Inherited from RibbonItem ) |
| | ToString | Returns a string that represents the current object. (Inherited from Object ) |
Remarks This class contains a collection of ToggleButtons. Only one of the ToggleButtons will appear active at a given time. When a different button is clicked in the UI the current ToggleButton will be changed, and the ToggleButton's external command will be invoked. Use of this class is not supported in Revit Macros.
Example private void AddRadioGroup(RibbonPanel panel)
{
// add radio button group
RadioButtonGroupData radioData = new RadioButtonGroupData("radioGroup");
RadioButtonGroup radioButtonGroup = panel.AddItem(radioData) as RadioButtonGroup;
// create toggle buttons and add to radio button group
ToggleButtonData tb1 = new ToggleButtonData("toggleButton1", "Red");
tb1.ToolTip = "Red Option";
tb1.LargeImage = new BitmapImage(new Uri(@"D:\Sample\HelloWorld\bin\Debug\Red.bmp"));
ToggleButtonData tb2 = new ToggleButtonData("toggleButton2", "Green");
tb2.ToolTip = "Green Option";
tb2.LargeImage = new BitmapImage(new Uri(@"D:\Sample\HelloWorld\bin\Debug\Green.bmp"));
ToggleButtonData tb3 = new ToggleButtonData("toggleButton3", "Blue");
tb3.ToolTip = "Blue Option";
tb3.LargeImage = new BitmapImage(new Uri(@"D:\Sample\HelloWorld\bin\Debug\Blue.bmp"));
radioButtonGroup.AddItem(tb1);
radioButtonGroup.AddItem(tb2);
radioButtonGroup.AddItem(tb3);
}