FailureMessageAccessor
Restricted accessor for FailureMessage.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.FailureMessageAccessor
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class FailureMessageAccessor : IDisposableThe FailureMessageAccessor type exposes the following members.
Properties
Name
Description
Public Property
IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
Methods
Name
Description
Public Method
CloneFailureMessage
Creates a copy of the FailureMessage.
Public Method
Dispose
Releases all resources used by the FailureMessageAccessor
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object)
Public Method
GetAdditionalElementIds
Retrieves Ids of Elements that have not caused the failure but are related to it Checks if the failure has resolution of a given resolution type.
Public Method
GetCurrentResolutionType
Retrieves the type of resolution to be used to resolve the failure.
Public Method
GetDefaultResolutionCaption
Retrieves the caption of default resolution of the failure.
Public Method
GetDescriptionText
Retrieves the description of the failure.
Public Method
GetFailingElementIds
Retrieves Ids of Elements that have caused the failure.
Public Method
GetFailureDefinitionId
Retrieves the Id of the FailureDefinition of the failure.
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object)
Public Method
GetNumberOfResolutions
Retrieves number of resolutions that can be used to resolve failure.
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
SetCurrentResolutionType
Sets the type of a resolution to be used to resolve the failure.
Public Method
ShouldMergeWithMessage
Checks if the FailureMessage should be merged with the other FailureMessage for better user experience.
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)
Remarks
Provides access to a FailureMessage stored in a Document. Reading of the information from the FailureMessage is allowed, changing of information is generally not allowed, except setting of the current resolution type.