Revit 2022 API |
RevitAPIEventArgs..::..Cancellable Property |
RevitAPIEventArgs Class See Also |
Indicates whether an event may be cancelled by an event delegate.
Namespace: Autodesk.Revit.DB.Events
Assembly: RevitAPI (in RevitAPI.dll) Version: 22.0.0.0 (22.1.0.0)
Since:
2011
Syntax
C# |
---|
public bool Cancellable { get; } |
Visual Basic |
---|
Public ReadOnly Property Cancellable As Boolean Get |
Visual C++ |
---|
public: property bool Cancellable { bool get (); } |
Remarks
If Cancellable returns true, event delegates may cancel the command that
was announced by the event. To do so, a delegate may call the Cancel() method if it is available.
Typically, single-events and post-events (e.g. DocumentPrinted) are not cancellable,
while most pre-events (e.g. DocumentPrinting) are cancellable, except for special
conditions and situations, such as when the Revit application is being closed
or if an event is raised during another event.