Namespace: Autodesk.Revit.DB.Events

FailuresProcessingEventArgs

Class

Description:
The event arguments used by the FailuresProcessing event.

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.

Inheritance Hierarchy:
System.Object
  System.EventArgs
    Autodesk.Revit.DB.Events.RevitAPIEventArgs
      Autodesk.Revit.DB.Events.RevitAPISingleEventArgs
        Autodesk.Revit.DB.Events.FailuresProcessingEventArgs

Syntax

public class FailuresProcessingEventArgs : RevitAPISingleEventArgs

Public Class FailuresProcessingEventArgs
	Inherits RevitAPISingleEventArgs

public ref class FailuresProcessingEventArgs : public RevitAPISingleEventArgs

type FailuresProcessingEventArgs = 
    class
        inherit RevitAPISingleEventArgs
    end

FailuresProcessingEventArgs Class Members:

Name	Description	Inherited From
Cancellable	Indicates whether an event may be cancelled by an event delegate. (Inherited from RevitAPIEventArgs )	RevitAPIEventArgs
IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from RevitAPIEventArgs )	RevitAPIEventArgs

Name	Description	Inherited From
Dispose	(Inherited from RevitAPIEventArgs )	RevitAPIEventArgs
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
GetFailuresAccessor	Provides access to the failure information in the document.
GetHashCode	Serves as the default hash function. (Inherited from Object )	Object
GetProcessingResult	Retrieves current status of the failures processing result.
GetType	Gets the Type of the current instance. (Inherited from Object )	Object
IsCancelled	Indicates whether the event is being cancelled. (Inherited from RevitAPIEventArgs )	RevitAPIEventArgs
SetProcessingResult	Sets the result of the failures processing accomplished during this event callback.
ToString	Returns a string that represents the current object. (Inherited from Object )	Object