PushButton

Description:
The PushButton object represents an button on a RibbonPanel.

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.PushButton
        Autodesk.Revit.UI.ToggleButton

public class PushButton : RibbonButton

Public Class PushButton _
	Inherits RibbonButton

public ref class PushButton : public RibbonButton

private void AddPushButton(RibbonPanel panel)
{
    PushButton pushButton = panel.AddItem(new PushButtonData("HelloWorld",
        "HelloWorld", @"D:\Sample\HelloWorld\bin\Debug\HelloWorld.dll", "HelloWorld.CsHelloWorld")) as PushButton;

    // Set ToolTip and contextual help
    pushButton.ToolTip = "Say Hello World";
    ContextualHelp contextHelp = new ContextualHelp(ContextualHelpType.Url,
        "http://www.autodesk.com");
   pushButton.SetContextualHelp(contextHelp);

    // Set the large image shown on button
    pushButton.LargeImage = 
        new BitmapImage(new Uri(@"D:\Sample\HelloWorld\bin\Debug\39-Globe_32x32.png"));
}

Private Sub AddPushButton(panel As RibbonPanel)
   Dim pushButton As PushButton = TryCast(panel.AddItem(New PushButtonData("HelloWorld", "HelloWorld", "D:\Sample\HelloWorld\bin\Debug\HelloWorld.dll", "HelloWorld.CsHelloWorld")), PushButton)

   ' Set ToolTip and contextual help
   pushButton.ToolTip = "Say Hello World"
   Dim contextHelp As New ContextualHelp(ContextualHelpType.Url, "http://www.autodesk.com")
   pushButton.SetContextualHelp(contextHelp)

   ' Set the large image shown on button
   pushButton.LargeImage = New BitmapImage(New Uri("D:\Sample\HelloWorld\bin\Debug\39-Globe_32x32.png"))
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

Name	Return Type	Description	Inherited From
P AssemblyName	string	The assembly path of the button.
P AvailabilityClassName	string	The full class name for the class providing the entry point to decide availability of this push button.
P ClassName	string	The name of the class containing the implementation for the command.
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