Share

FailuresProcessingEventArgs Class

The event arguments used by the FailuresProcessing event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Autodesk.Revit.DB.Events.RevitAPIEventArgs
      Autodesk.Revit.DB.Events.RevitAPISingleEventArgs
        Autodesk.Revit.DB.Events.FailuresProcessingEventArgs


Namespace: Autodesk.Revit.DB.Events
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)

Syntax

C#

public class FailuresProcessingEventArgs : RevitAPISingleEventArgs

The FailuresProcessingEventArgs type exposes the following members.

Properties

 NameDescription
Public propertyCancellable Indicates whether an event may be cancelled by an event delegate.
(Inherited from RevitAPIEventArgs)
Public propertyIsValidObject Specifies whether the .NET object represents a valid Revit entity.
(Inherited from RevitAPIEventArgs)

Methods

 NameDescription
Public methodDispose
(Inherited from RevitAPIEventArgs)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetFailuresAccessor Provides access to the failure information in the document.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetProcessingResult Retrieves current status of the failures processing result.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsCancelled Indicates whether the event is being cancelled.
(Inherited from RevitAPIEventArgs)
Public methodSetProcessingResult Sets the result of the failures processing accomplished during this event callback.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)

Remarks

The event arguments provide access to the FailuresAccessor via GetFailuresAccessor() which contains the details of the errors and/or warnings that caused the event to trigger.

The arguments also allow you to set a processing result via SetProcessingResult(FailureProcessingResult). The processing result determines if Revit will attempt to recommit the currently failing transaction, roll it back, or continue. If you are explicitly dismissing warnings from the event callback, a processing result of Continue is sufficient. But if you are explicitly resolving errors from the event callback, you must change the processing result to ProceedWithCommit to ensure that the user is not shown the dismissed errors. If you wish to cancel the transaction silently without showing the errors to the user, set the processing result to ProceedWithRollback, however you must also call SetClearAfterRollback(Boolean) in order to dismiss the errors and silently cancel the transaction.

See Also

Reference

Was this information helpful?