Sign in
2027 Class
Changes 0
C

RadioButtonGroup

Description:
Represents a group of related buttons in the Ribbon.
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.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.UI.RibbonItem
    Autodesk.Revit.UI.RadioButtonGroup
public class RadioButtonGroup : RibbonItem
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);
}
Name Return Type Description Inherited From
M AddItem(ToggleButtonData) ToggleButton Adds a new ToggleButton to the RadioButtonGroup.
M AddItems(IList<ToggleButtonData>) IList<ToggleButton> Adds new ToggleButtons to the RadioButtonGroup.
M Equals(Object) Boolean Determines whether the specified Object is equal to the current Object . (Inherited from RibbonItem ) RibbonItem
M GetContextualHelp() ContextualHelp Gets the contextual help bound with this control. (Inherited from RibbonItem ) RibbonItem
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetItems() IList<ToggleButton> Gets the collection of ToggleButtons assigned to the RadioButtonGroup.
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M SetContextualHelp(ContextualHelp) None Sets the contextual help bound with this button. (Inherited from RibbonItem ) RibbonItem
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P Current ToggleButton Gets or sets the current checked ToggleButton of the RadioButtonGroup.
P Enabled bool Gets or sets a value indicating whether the item is enabled. (Inherited from RibbonItem ) RibbonItem
P ItemText string Gets or sets the text displayed on the item. (Inherited from RibbonItem ) RibbonItem
P ItemType RibbonItemType Gets the item type. (Inherited from RibbonItem ) RibbonItem
P LongDescription string Long description of the command tooltip (Inherited from RibbonItem ) RibbonItem
P Name string The name of the item. (Inherited from RibbonItem ) RibbonItem
P ToolTip string The description that appears as a ToolTip for the item. (Inherited from RibbonItem ) RibbonItem
P ToolTipImage ImageSource The image to show as a part of the button extended tooltip (Inherited from RibbonItem ) RibbonItem
P Visible bool Gets or sets a value indicating whether the item is visible. (Inherited from RibbonItem ) RibbonItem