FailureMessage

Public Class

Represents a message describing a failure of an operation in Revit.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.FailureMessage

Namespace: Autodesk.Revit.DB

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

Syntax

public class FailureMessage : IDisposable

The FailureMessage type exposes the following members.

Constructors

Name

Description

---

Public Method
FailureMessage

Creates a new FailureMessage related to a given FailureDefinition.

---

Properties

Name

Description

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Methods

Name

Description

---

Public Method
AddResolution

Adds a resolution for the failure.

---

Public Method

Dispose

Releases all resources used by the FailureMessage

---

Public Method

Equals

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

---

Public Method

GetAdditionalElements

Retrieves list of the additional reference elements for the failure.

---

Public Method

GetDefaultResolutionCaption

Retrieves the caption of the default resolution of the failure.

---

Public Method

GetDescriptionText

Retrieves the description text of the failure.

---

Public Method

GetFailingElements

Retrieves list of the elements that have caused the failure.

---

Public Method

GetFailureDefinitionId

Retrieves the id of the failure definition for the failure.

---

Public Method

GetHashCode

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

---

Public Method

GetSeverity

Retrieves the severity of the failure.

---

Public Method

GetType

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

---

Public Method

HasResolutionOfType

Checks if failure has a resolution of a given type.

---

Public Method

HasResolutions

Checks if the failure has any resolutions.

---

Public Method
SetAdditionalElement

Sets the additional reference element for the failure.

---

Public Method
SetAdditionalElements

Sets the additional reference elements for the failure.

---

Public Method
SetFailingElement

Sets the element that has caused the failure.

---

Public Method
SetFailingElements

Sets elements that have caused the failure.

---

Public Method

ToString

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

---

Remarks

Failure messages are typically shown to the user in the Revit error dialog. This class contains the following information about the failures:

1. The basic description of the failure (retrieved from the FailureDefinition)
2. The available resolutions for the failure.
3. The elements related to the failure.