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

Public Class SplitButton _
	Inherits PulldownButton

public ref class SplitButton : public 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);
}

Private Sub AddSplitButton(panel As RibbonPanel)
   Dim assembly As String = "D:\Sample\HelloWorld\bin\Debug\HelloWorld.dll"

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

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

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

   Dim sb1 As New SplitButtonData("splitButton1", "Split")
   Dim sb As SplitButton = TryCast(panel.AddItem(sb1), SplitButton)
   sb.AddPushButton(bOne)
   sb.AddPushButton(bTwo)
   sb.AddPushButton(bThree)
End Sub

Name	Return Type	Description	Inherited From
M Equals(Object)	bool	Determines whether the specified is equal to the current .	RibbonItem
M GetContextualHelp()	nullNothingnullptr	Gets the contextual help bound with this control.	RibbonItem
M SetContextualHelp(ContextualHelp)	None	Sets the contextual help bound with this button.	RibbonItem
M AddPushButton(PushButtonData)	PushButton	Adds a new pushbutton to the pulldown button and associates it with an ExternalCommand.	PulldownButton
M AddSeparator()	None	Adds a separator to the drop-down list.	PulldownButton
M GetItems()	IList<PushButton>	Gets a copy of the collection of buttons assigned to the pulldown button.	PulldownButton

Name	Return Type	Description	Inherited From
P CurrentButton	PushButton	Gets or sets the current PushButton of the SplitButton.
P IsSynchronizedWithCurrentItem	bool	Indicates whether the top PushButton on the SplitButton changes based on the CurrentButton property.
P Enabled	bool	Gets or sets a value indicating whether the item is enabled.	RibbonItem
P ItemText	string	Gets or sets the text displayed on the item.	RibbonItem
P ItemType	RibbonItemType	Gets the item type.	RibbonItem
P LongDescription	string	Long description of the command tooltip	RibbonItem
P Name	string	The name of the item.	RibbonItem
P ToolTipImage	ImageSource	The image to show as a part of the button extended tooltip	RibbonItem
P ToolTip	string	The description that appears as a ToolTip for the item.	RibbonItem
P Visible	bool	Gets or sets a value indicating whether the item is visible.	RibbonItem
P Image	ImageSource	The image of the button.	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.	RibbonButton
P LargeImage	ImageSource	The large image shown on the button.	RibbonButton