Autodesk.Revit.UI.TaskDialog

Autodesk.Revit.UI.TaskDialog is a class used in Autodesk Revit software that provides a dialog box to communicate information to the user.

Properties

Autodesk.Revit.UI.TaskDialog has the following properties:

• Caption: Gets or sets the caption displayed on the title bar of the dialog box.
• CommonButtons: Gets or sets the pre-defined buttons that appear at the bottom of the dialog box.
• DefaultButton: Gets or sets the button to which the Enter key is mapped.
• FooterIcon: Gets or sets the icon displayed in the footer of the dialog box.
• MainContent: Gets or sets the text displayed in the main area of the dialog box.
• MainIcon: Gets or sets the icon displayed in the left side of the dialog box.
• Owner: Gets or sets the window that owns the dialog box.
• Resizable: Gets or sets whether the user can resize the dialog box.
• TitleAutoPrefix: Gets or sets whether the caption automatically appends a prefix of the current product.
• TitleAutoSuffix: Gets or sets whether the caption automatically appends a suffix of the current product.

Methods

Autodesk.Revit.UI.TaskDialog has the following methods:

• AddCommandLink(TaskDialogCommandLinkData data): Adds a command link to the dialog box.
• AddOption(TaskDialogOptionData data): Adds an option button to the dialog box.
• ClearRadioButtons(): Removes all radio buttons from the dialog box.
• Dispose(): Releases all resources used by the Autodesk.Revit.UI.TaskDialog.
• RadioButtonList(TaskDialogRadioButtonListData data): Adds a list of radio buttons to the dialog box.
• Show(): Displays the dialog box and returns a TaskDialogResult value that indicates which button the user clicked.

Usage

Using Autodesk.Revit.UI.TaskDialog in your Revit add-in can enhance the user experience by providing customizable and informative dialog boxes. You can specify the message you want to display, the icons, the buttons, and even additional custom command links or option buttons.

Here's an example of how to create a simple TaskDialog:

TaskDialog taskDialog = new TaskDialog("My Dialog Box Title");
taskDialog.MainContent = "Hello, World!";
taskDialog.CommonButtons = TaskDialogCommonButtons.Ok;
TaskDialogResult result = taskDialog.Show();

This will display a dialog box with the title "My Dialog Box Title", the message "Hello, World!", and an "OK" button. Once the user clicks the button, the result value will be returned.

Conclusion

Autodesk.Revit.UI.TaskDialog is a useful class in Revit for providing informative and customizable dialog boxes. By using this class, you can enhance the user experience of your add-in, and make it more interactive and user-friendly.