Skip to content
RevitAPI doc lite

SplitButton

Public Class

The SplitButton object represents a button with a clickable button appearing above a pulldown.

Inheritance Hierarchy

System.Object
Autodesk.Revit.UI.RibbonItem
Autodesk.Revit.UI.RibbonButton
Autodesk.Revit.UI.PulldownButton
Autodesk.Revit.UI.SplitButton

Namespace: Autodesk.Revit.UI

Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class SplitButton : PulldownButton

The SplitButton type exposes the following members.

Properties

Name

Description

Public Property
CurrentButton

Gets or sets the current PushButton of the SplitButton.

Public Property
Enabled

Gets or sets a value indicating whether the item is enabled.
(Inherited from RibbonItem)

Public Property
Image

The image of the button.
(Inherited from RibbonButton)

Public Property
IsEnabledByContext

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)

Public Property
IsSynchronizedWithCurrentItem

Indicates whether the top PushButton on the SplitButton changes based on the CurrentButton property.

Public Property
ItemText

Gets or sets the text displayed on the item.
(Inherited from RibbonItem)

Public Property

ItemType

Gets the item type.
(Inherited from RibbonItem)

Public Property
LargeImage

The large image shown on the button.
(Inherited from RibbonButton)

Public Property
LongDescription

Long description of the command tooltip
(Inherited from RibbonItem)

Public Property

Name

The name of the item.
(Inherited from RibbonItem)

Public Property
ToolTip

The description that appears as a ToolTip for the item.
(Inherited from RibbonItem)

Public Property
ToolTipImage

The image to show as a part of the button extended tooltip
(Inherited from RibbonItem)

Public Property
Visible

Gets or sets a value indicating whether the item is visible.
(Inherited from RibbonItem)

Methods

Name

Description

Public Method
AddPushButton

Adds a new pushbutton to the pulldown button and associates it with an ExternalCommand.
(Inherited from PulldownButton)

Public Method
AddSeparator

Adds a separator to the drop-down list.
(Inherited from PulldownButton)

Public Method

Equals

Determines whether the specified Object is equal to the current Object.
(Inherited from RibbonItem)

Public Method

GetContextualHelp

Gets the contextual help bound with this control.
(Inherited from RibbonItem)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetItems

Gets a copy of the collection of buttons assigned to the pulldown button.
(Inherited from PulldownButton)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

SetContextualHelp

Sets the contextual help bound with this button.
(Inherited from RibbonItem)

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

Use of this class is not supported in Revit Macros.

Example

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);
}