2027 Class
Changes 0
C

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
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"));
}
Name Return Type Description Inherited From
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 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 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. (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 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