Skip to content
RevitAPI doc lite

DialogBoxData

Public Class

An object that is passed to your application when a dialog is displayed in Revit.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.APIObject
Autodesk.Revit.UI.Events.DialogBoxData
Autodesk.Revit.UI.Events.MessageBoxData

Namespace: Autodesk.Revit.UI.Events

Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class DialogBoxData : APIObject

The DialogBoxData type exposes the following members.

Properties

Name

Description

Public Property
HelpId

An ID that represents the dialog that has been displayed.

Public Property
Code Example

IsReadOnly

Identifies if the object is read-only or modifiable.
(Inherited from APIObject)

Methods

Name

Description

Public Method
Dispose

Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject)

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

OverrideResult

Call this method to cause the Autodesk Revit dialog to be dismissed with the specified return value.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

When the application receives this object, a dialog has been 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.