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 | Inherited From |
|---|---|---|---|
| CloneFailureMessage() | FailureMessage | Creates a copy of the FailureMessage. | |
| Dispose() | None | Releases all resources used by the FailureMessageAccessor | |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| 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() | String | 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. | |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetNumberOfResolutions() | Int32 | Retrieves number of resolutions that can be used to resolve failure. | |
| GetSeverity() | FailureSeverity | Retrieves the severity of the failure. | |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| HasResolutionOfType(FailureResolutionType) | Boolean | Checks if failure has a resolution of a given type. | |
| HasResolutions() | Boolean | 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) | Boolean | Checks if the FailureMessage should be merged with the other FailureMessage for better user experience. | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. |