Task |
A task dialog is a dialog box that can be used to display information and receive simple input from the user. It has a common set of controls that are arranged in a standard order to assure consistent look and feel.
Inheritance Hierarchy Namespace: Autodesk.Revit.UI
Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax The TaskDialog type exposes the following members.
Constructors | Name | Description | |
|---|---|---|
 | TaskDialog | Creates a task dialog with title. |
Properties | Name | Description | |
|---|---|---|
 | AllowCancellation | Whether the task dialog can be cancelled if no cancel button is specified. |
| | CommonButtons | The push buttons displayed in the task dialog. |
| | DefaultButton | The default button for the dialog. |
| | EnableMarqueeProgressBar | Enables a marquee style progress bar to be displayed in the TaskDialog. |
| | ExpandedContent | ExpandedContent is hidden by default and will display at the bottom of the task dialog when the "Show details" button is pressed. |
| | ExtraCheckBoxText | ExtraCheckBoxText is used to label the extra checkbox. |
| | FooterText | FooterText is used in the footer area of the task dialog. |
| | Id | The Id of the task dialog. |
| | IsReadOnly | Identifies if the object is read-only or modifiable. (Inherited from APIObject ) |
| | MainContent | MainContent is the smaller text that appears just below the main instructions. |
| | MainIcon | The icon shown in the task dialog. |
| | MainInstruction | The large primary text that appears at the top of a task dialog. |
| | Title | Title of the task dialog. |
| | TitleAutoPrefix | Whether the TaskDialog's title will automatically have the add-in name added as a prefix. |
| | VerificationText | VerificationText is used to label the verification checkbox. |
Methods | Name | Description | |
|---|---|---|
| | AddCommandLink(TaskDialogCommandLinkId, String) | Adds a CommandLink associated to the given id, displaying the indicating main content. |
| | AddCommandLink(TaskDialogCommandLinkId, String, String) | Adds a CommandLink associated to the given id, displaying the indicating main and supporting content. |
| | Dispose | Causes the object to release immediately any resources it may be utilizing. (Inherited from APIObject ) |
| | EnableDoNotShowAgain | Enables the "Do not show again" for a task dialog. |
| | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) |
| | GetHashCode | Serves as the default hash function. (Inherited from Object ) |
| | GetType | Gets the Type of the current instance. (Inherited from Object ) |
| | Show | Shows the task dialog. |
 | Show(String, String) | Shows a task dialog with title, main instruction and a Close button. |
| | Show(String, String, TaskDialogCommonButtons) | Shows a task dialog with title, main instruction and common buttons. |
| | Show(String, String, TaskDialogCommonButtons, TaskDialogResult) | Shows a task dialog with title, main instruction, common buttons and default buttons. |
| | ToString | Returns a string that represents the current object. (Inherited from Object ) |
| | WasExtraCheckBoxChecked | Gets the status of the extra checkbox. |
| | WasVerificationChecked | Gets the status of the verification checkbox. |
Remarks There are two ways to create and show a task dialog to the user. The first option is to construct the TaskDialog, set its properties individually, and use the instance method Show() to show it to the user. The second is to use one of the static Show() methods to construct and show the dialog in one step. When you use the static methods only a subset of the options can be specified.
Please follow Revit standards to create task dialogs. The standards are listed in the remarks of each property or method.
See Also