2024 Class
Changes 0
C

FailureMessageAccessor

Description:
Restricted accessor for FailureMessage.
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.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.FailureMessageAccessor
public class FailureMessageAccessor : IDisposable
Name Return Type Description
M CloneFailureMessage() FailureMessage Creates a copy of the FailureMessage.
M Dispose() None Releases all resources used by the
M GetAdditionalElementIds() ICollection<ElementId> 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.
M GetCurrentResolutionType() FailureResolutionType Retrieves the type of resolution to be used to resolve the failure.
M GetDefaultResolutionCaption() string Retrieves the caption of default resolution of the failure.
M GetDescriptionText() The description text. Retrieves the description of the failure.
M GetFailingElementIds() ICollection<ElementId> Retrieves Ids of Elements that have caused the failure.
M GetFailureDefinitionId() FailureDefinitionId Retrieves the Id of the FailureDefinition of the failure.
M GetNumberOfResolutions() int Retrieves number of resolutions that can be used to resolve failure.
M GetSeverity() FailureSeverity Retrieves the severity of the failure.
M HasResolutionOfType(FailureResolutionType) bool Checks if failure has a resolution of a given type.
M HasResolutions() bool Checks if the failure has any resolutions.
M SetCurrentResolutionType(FailureResolutionType) None Sets the type of a resolution to be used to resolve the failure.
M ShouldMergeWithMessage(FailureMessageAccessor) bool Checks if the FailureMessage should be merged with the other FailureMessage for better user experience.
Name Return Type Description
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.