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