Autodesk.Revit.UI.ButtonData

类型：类

命名空间：Autodesk.Revit.UI

程序集：RevitAPIUI.dll

Autodesk.Revit.UI.ButtonData是Revit API中用于创建Revit UI按钮的类。按钮可以在Revit的工具栏、选项卡或面板上显示，用于触发特定的命令或操作。

属性：

• Name：按钮的名称。必需属性。
• Text：按钮的显示文本。必需属性。
• ToolTip：按钮的提示信息。
• LargeImage：按钮的大图标。必需属性。
• SmallImage：按钮的小图标。必需属性。
• Image：按钮的图标。如果同时设置了LargeImage和SmallImage，则优先使用LargeImage。如果只设置了一个，则该属性也可以使用。

方法：

• ButtonData (string name, string text)： 创建一个按钮数据对象。
• SetToolTip (string toolTip)：设置按钮的提示信息。
• SetContextualHelp (ContextualHelp contextHelp)：设置按钮的上下文帮助信息。
• SetImage (Bitmap image)：设置按钮的图标。如果同时设置了LargeImage和SmallImage，则优先使用LargeImage。如果只设置了一个，则该属性也可以使用。
• SetLargeImage (Bitmap largeImage)：设置按钮的大图标。
• SetSmallImage (Bitmap smallImage)：设置按钮的小图标。

示例：

//创建按钮数据对象
ButtonData buttonData = new ButtonData("MyButton", "My Button");

//设置按钮文本、大/小图标和提示信息
buttonData.LargeImage = new Bitmap("buttonLargeIcon.png");
buttonData.SmallImage = new Bitmap("buttonSmallIcon.png");
buttonData.ToolTip = "This is my button";

//使用按钮数据创建Revit UI按钮
PushButton pushButton = panel.AddItem(buttonData) as PushButton;
pushButton.ToolTip = "This is my button"; //覆盖ButtonData中的提示信息
pushButton.AvailabilityClassName = "MyAvailabilityClassName"; //设置按钮的可用性检查类

备注：

• 此类只用于创建Revit的UI按钮，不能直接和Revit的命令或API进行绑定。按钮的触发方法需要在创建按钮的插件中自行实现。
• 在插件的OnStartup方法中创建的所有按钮都将在Revit启动时显示。如果需要根据用户的操作显示或隐藏某些按钮，则需要使用ExternalEventHandler等其他自定义方式实现。
• 在按钮的AvailabilityClassName属性中指定的类必须实现IAvailability接口，并重写其中的方法定义按钮可用性的判断逻辑。