DocumentSaveToLocalProgressChangedEventArgs
The event arguments used during the save to local phase of [!:Autodesk::Revit::ApplicationServices::Application::WorksharedOperationProgressChanged].
Inheritance Hierarchy
System.Object
System.EventArgs
Autodesk.Revit.DB.Events.RevitAPIEventArgs
Autodesk.Revit.DB.Events.RevitAPISingleEventArgs
Autodesk.Revit.DB.Events.WorksharedOperationProgressChangedEventArgs
Autodesk.Revit.DB.Events.DocumentSaveToLocalProgressChangedEventArgs
Namespace: Autodesk.Revit.DB.Events
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class DocumentSaveToLocalProgressChangedEventArgs : WorksharedOperationProgressChangedEventArgsThe DocumentSaveToLocalProgressChangedEventArgs type exposes the following members.
Properties
Name
Description
Public Property
BeforeSaveToCentral
True if the “save to local” operation is occurring before “save to central”; false if after.
Public Property
Cancellable
Indicates whether an event may be cancelled by an event delegate.
(Inherited from RevitAPIEventArgs)
Public Property
FinishedStreams
The number of streams finished since the last time this event was raised.
Public Property
IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from RevitAPIEventArgs)
Public Property
Location
Full path of the central model which is to be operated.
(Inherited from WorksharedOperationProgressChangedEventArgs)
Public Property
SaveToLocalFinished
Indicates if the current “save to local” operation has finished.
Public Property
Status
Gets API event status, reflect current operation execution status.
(Inherited from WorksharedOperationProgressChangedEventArgs)
Public Property
TotalStreams
The total expected number of streams to save to local.
Methods
Name
Description
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)
Remarks
It is NOT recommended to do any time-consuming work when handling WorksharedOperationProgressChanged event. This can increase workshared operation time. Name correction - it is renamed from ‘DocumentSaveToLocalProgessChangedEventArgs’ released since 2017 Subscription Update.