2027 Class
Changes 0
C

FailuresAccessor

Description:
An interface class that provides access to failure information posted in a document and methods to resolve these failures.
Remarks:
An instance of this class can be obtained only as an argument passed to interfaces used in the process of failure resolution and is the only available interface to fetch information about failures in a document. While reading from a document during failure processing is allowed, the only way to modify document during failure resolution is via methods provided by this class. After returning from failure processing, the instance of the class is deactivated and cannot be used any longer.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.FailuresAccessor
public class FailuresAccessor : IDisposable
Name Return Type Description Inherited From
M CanCommitPendingTransaction() Boolean Checks if pending failure processing can be finished by committing a pending transaction.
M CanRollBackPendingTransaction() Boolean Checks if pending failure processing can be finished by rolling back a pending transaction.
M CommitPendingTransaction() TransactionStatus Finishes pending failures processing by committing the pending transaction.
M DeleteAllWarnings() None Deletes all FailureMessages of severity "Warning" currently posted in a document.
M DeleteElements(IList<ElementId>) None Resolves failures by deletion of elements related to the failures.
M DeleteWarning(FailureMessageAccessor) None Deletes one specific failure message of severity "Warning".
M Dispose() None Releases all resources used by the FailuresAccessor
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetAttemptedResolutionTypes(FailureMessageAccessor) IList<FailureResolutionType> Returns list of the failure resolution types attempted for the failure in the current transaction.
M GetDocument() Document Provides access to a document for which failures are being processed or preprocessed.
M GetFailureHandlingOptions() FailureHandlingOptions Provides access to the failure handling options for the transaction currently being finished.
M GetFailureMessages() IList<FailureMessageAccessor> Provides access to the individual failure messages currently posted in the document.
M GetFailureMessages(FailureSeverity) IList<FailureMessageAccessor> Provides access to the individual failure messages if a given severity currently posted in the document.
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetSeverity() FailureSeverity Provides access to the current failure severity.
M GetTransactionName() String Retrieves the name of the transaction for which failures are being processed.
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M IsActive() Boolean Method allows to check if this instance of the accessor is currently active.
M IsElementsDeletionPermitted() Boolean Checks if resolution of the failures by deleting failure elements is permitted.
M IsElementsDeletionPermitted(IList<ElementId>) Boolean Checks if resolution of the failures by deleting given collection of elements is permitted.
M IsElementsDeletionPermitted(IList<ElementId>, String%) Boolean Checks if resolution of the failures by deleting given collection of elements is permitted.
M IsFailureResolutionPermitted() Boolean Checks if resolution of failures is permitted.
M IsFailureResolutionPermitted(FailureMessageAccessor) Boolean Checks if default resolution of the failure is permitted.
M IsFailureResolutionPermitted(FailureMessageAccessor, FailureResolutionType) Boolean Checks if resolution of the failure using given resolution type is permitted.
M IsPending() Boolean Checks if the failure processing is pending.
M IsTransactionBeingCommitted() Boolean Checks if the transaction for which failures are processed is being committed or rolled back.
M JournalFailures(IList<FailureMessageAccessor>) None Allows to record information about failures in the journal.
M PostFailure(FailureMessage) None Posts an additional failure message to be processed for the current transaction.
M ReplaceFailures(FailureMessage) None Deletes all failure messages currently posted in a document and replaces them with one "generic" failure.
M ResolveFailure(FailureMessageAccessor) None Resolves one failure using the failure resolution type last set for it.
M ResolveFailures(IList<FailureMessageAccessor>) None Resolves one or more failures using last set failure resolution type for each of the failures. If failure resolution type was not set for some of failures, default failure resolution type will be used.
M RollBackPendingTransaction() TransactionStatus Finishes pending failures processing by rolling back the pending transaction.
M SetFailureHandlingOptions(FailureHandlingOptions) None Sets failure handling options for the transaction currently being finished.
M SetTransactionName(String) None Changes the name of the transaction for which failures are being processed.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity.