RVTDocs.com

TaskDialogShowingEventArgs

Class
Description:
The event arguments used by the DialogBoxShowing event when a Revit task dialog that prompts the user for some action is shown.
Remarks:
When the application receives this object, a task dialog is about to be displayed in Revit that requires user interaction. The OverrideResult function can be used to cause the dialog to be dismissed and return a desired result code.
Inheritance Hierarchy:
System.Object
  System.EventArgs
    Autodesk.Revit.DB.Events.RevitAPIEventArgs
      Autodesk.Revit.DB.Events.RevitAPIPreEventArgs
        Autodesk.Revit.UI.Events.DialogBoxShowingEventArgs
          Autodesk.Revit.UI.Events.TaskDialogShowingEventArgs
TaskDialogShowingEventArgs Class Members:
Name Description Inherited From
Cancellable Indicates whether an event may be cancelled by an event delegate. (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
DialogId A unique string identifier for DialogBox and TaskDialog type dialogs in Revit. (Inherited from DialogBoxShowingEventArgs ) DialogBoxShowingEventArgs
IsValidObject Specifies whether the .NET object represents a valid Revit entity. (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
Message The message that has been displayed in the dialog box.
Name Description Inherited From
Cancel When the event is cancellable, may call the Cancel() method to cancel it. (Inherited from RevitAPIPreEventArgs ) RevitAPIPreEventArgs
Dispose (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
Equals Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
GetHashCode Serves as the default hash function. (Inherited from Object ) Object
GetType Gets the Type of the current instance. (Inherited from Object ) Object
IsCancelled Indicates whether the event is being cancelled. (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
OverrideResult Call this method to cause the Autodesk Revit dialog to be dismissed with the specified return value. (Inherited from DialogBoxShowingEventArgs ) DialogBoxShowingEventArgs
ToString Returns a string that represents the current object. (Inherited from Object ) Object