2027 Class
Changes 0
C

SplitButton

Description:
The SplitButton object represents a button with a clickable button appearing above a pulldown.
Remarks:
Use of this class is not supported in Revit Macros.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.UI.RibbonItem
    Autodesk.Revit.UI.RibbonButton
      Autodesk.Revit.UI.PulldownButton
        Autodesk.Revit.UI.SplitButton
public class SplitButton : PulldownButton
private void AddSplitButton(RibbonPanel panel)
{
    string assembly = @"D:\Sample\HelloWorld\bin\Debug\HelloWorld.dll";

    // create push buttons for split button drop down
    PushButtonData bOne = new PushButtonData("ButtonNameA", "Option One",
        assembly, "Hello.HelloOne");
    bOne.LargeImage = 
        new BitmapImage(new Uri(@"D:\Sample\HelloWorld\bin\Debug\One.bmp"));

    PushButtonData bTwo = new PushButtonData("ButtonNameB", "Option Two",
        assembly, "Hello.HelloTwo");
    bTwo.LargeImage = 
        new BitmapImage(new Uri(@"D:\Sample\HelloWorld\bin\Debug\Two.bmp"));

    PushButtonData bThree = new PushButtonData("ButtonNameC", "Option Three",
        assembly, "Hello.HelloThree");
    bThree.LargeImage = 
        new BitmapImage(new Uri(@"D:\Sample\HelloWorld\bin\Debug\Three.bmp"));

    SplitButtonData sb1 = new SplitButtonData("splitButton1", "Split");
    SplitButton sb = panel.AddItem(sb1) as SplitButton;
    sb.AddPushButton(bOne);
    sb.AddPushButton(bTwo);
    sb.AddPushButton(bThree);
}
Name Return Type Description Inherited From
M AddPushButton(PushButtonData) PushButton Adds a new pushbutton to the pulldown button and associates it with an ExternalCommand. (Inherited from PulldownButton ) PulldownButton
M AddSeparator() None Adds a separator to the drop-down list. (Inherited from PulldownButton ) PulldownButton
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<PushButton> Gets a copy of the collection of buttons assigned to the pulldown button. (Inherited from PulldownButton ) PulldownButton
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 CurrentButton PushButton Gets or sets the current PushButton of the SplitButton.
P Enabled bool Gets or sets a value indicating whether the item is enabled. (Inherited from RibbonItem ) RibbonItem
P Image ImageSource The image of the button. (Inherited from RibbonButton ) RibbonButton
P IsEnabledByContext bool Indicates if this button can be executed. True if the pushbutton is permitted to be executed based on the current Revit context (active document, active view and active tool). False if the pushbutton is disabled because of the active context. (Inherited from RibbonButton ) RibbonButton
P IsSynchronizedWithCurrentItem bool Indicates whether the top PushButton on the SplitButton changes based on the CurrentButton property.
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 LargeImage ImageSource The large image shown on the button. (Inherited from RibbonButton ) RibbonButton
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