Skip to content
RevitAPI doc lite

PushButton

Public Class

The PushButton object represents an button on a RibbonPanel.

Inheritance Hierarchy

System.Object
Autodesk.Revit.UI.RibbonItem
Autodesk.Revit.UI.RibbonButton
Autodesk.Revit.UI.PushButton
Autodesk.Revit.UI.ToggleButton

Namespace: Autodesk.Revit.UI

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

Syntax

public class PushButton : RibbonButton

The PushButton type exposes the following members.

Properties

Name

Description

Public Property
AssemblyName

The assembly path of the button.

Public Property
AvailabilityClassName

The full class name for the class providing the entry point to decide availability of this push button.

Public Property
ClassName

The name of the class containing the implementation for the command.

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
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

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

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