Task Dialog Showing Event Args Class

The event arguments used by the DialogBoxShowing event when a Revit task dialog that prompts the user for some action is shown.

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

Namespace: Autodesk.Revit.UI.Events
Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

C++

public class TaskDialogShowingEventArgs : DialogBoxShowingEventArgs

Public Class TaskDialogShowingEventArgs
	Inherits DialogBoxShowingEventArgs

public ref class TaskDialogShowingEventArgs : public DialogBoxShowingEventArgs

type TaskDialogShowingEventArgs = 
    class
        inherit DialogBoxShowingEventArgs
    end

The TaskDialogShowingEventArgs type exposes the following members.

Properties

	Name	Description
	Cancellable	Indicates whether an event may be cancelled by an event delegate. (Inherited from RevitAPIEventArgs )
	DialogId	A unique string identifier for DialogBox and TaskDialog type dialogs in Revit. (Inherited from DialogBoxShowingEventArgs )
	IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from RevitAPIEventArgs )
	Message	The message that has been displayed in the dialog box.

Top

Methods

	Name	Description
	Cancel	When the event is cancellable, may call the Cancel() method to cancel it. (Inherited from RevitAPIPreEventArgs )
	Dispose	(Inherited from RevitAPIEventArgs )
	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 )
	IsCancelled	Indicates whether the event is being cancelled. (Inherited from RevitAPIEventArgs )
	OverrideResult	Call this method to cause the Autodesk Revit dialog to be dismissed with the specified return value. (Inherited from DialogBoxShowingEventArgs )
	ToString	Returns a string that represents the current object. (Inherited from Object )

Top

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.

Reference

Autodesk.Revit.UI.Events Namespace

TaskDialogShowingEventArgs Class

Task Dialog Showing Event Args Class

Reference