ProgressChangedEventArgs
The event arguments used by the ProgressChanged event.
Inheritance Hierarchy
System.Object
System.EventArgs
Autodesk.Revit.DB.Events.RevitAPIEventArgs
Autodesk.Revit.DB.Events.RevitAPISingleEventArgs
Autodesk.Revit.DB.Events.ProgressChangedEventArgs
Namespace: Autodesk.Revit.DB.Events
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class ProgressChangedEventArgs : RevitAPISingleEventArgsThe ProgressChangedEventArgs type exposes the following members.
Properties
Name
Description
Public Property
Cancellable
Indicates whether an event may be cancelled by an event delegate.
(Inherited from RevitAPIEventArgs)
Public Property
Caption
The text from the progress bar caption that describes the operation in progress
Public Property
IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from RevitAPIEventArgs)
Public Property
LowerRange
Lower part of progress bar range - always zero
Public Property
Position
Progress bar position - value is always between zero and upperRange and is incremented by one with each event of stage “PositionChanged”
Public Property
Stage
The current stage of the progress bar
Public Property
UpperRange
Upper part of progress bar range - will be any non-zero number
Methods
Name
Description
Public Method
Cancel
Requests to cancel the progress bar’s operation.
Public Method
Dispose
(Inherited from RevitAPIEventArgs)
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object)
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
IsCancelled
Indicates whether the event is being cancelled.
(Inherited from RevitAPIEventArgs)
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object)