FailureHandlingOptions

Public Class

Options to control how failures (if any occurred during the transaction) should be handled at the time the transaction is being ended.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.FailureHandlingOptions

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class FailureHandlingOptions : IDisposable

The FailureHandlingOptions type exposes the following members.

Properties

Name

Description

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the FailureHandlingOptions

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetClearAfterRollback

Obtains the flag indicating if all posted failures should be removed silently when transaction is being rolled back.

---

Public Method

GetDelayedMiniWarnings

Obtains the flag indicating if showing of mini-warning dialog should be delayed until the end of next transaction.

---

Public Method

GetFailuresPreprocessor

Gets the callback to be invoked in the beginning of failure processing.

---

Public Method

GetForcedModalHandling

Obtains the flag indicating if the error handling dialog shown at the end of the failing transaction should be modal.

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetTransactionFinalizer

Gets the callback to be executed after transaction is completed.

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

SetClearAfterRollback

Sets a flag indicating that Revit should clear all posted failures silently when the failing transaction is being rolled back intentionally. If not set, the failures may still be displayed to the user during rollback.

---

Public Method
SetDelayedMiniWarnings

Sets a flag indicating if Revit should delay the display of the mini-warning dialog (if one is to be shown as a result of warnings in the current transaction) until the end of the next transaction.

---

Public Method

SetFailuresPreprocessor

Sets the callback to be invoked in the beginning of failure processing.

---

Public Method

SetForcedModalHandling

Sets a flag indicating whether Revit will show a modal (blocking) error dialog if the transaction failed to finish.

---

Public Method

SetTransactionFinalizer

Sets the callback to be executed after the transaction is completed.

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---