Revit 2025.3 API
Document |
The event arguments used during the save to local phase of [!:Autodesk::Revit::ApplicationServices::Application::WorksharedOperationProgressChanged].
Inheritance HierarchySystemObject
SystemEventArgs
Autodesk.Revit.DB.EventsRevitAPIEventArgs
Autodesk.Revit.DB.EventsRevitAPISingleEventArgs
Autodesk.Revit.DB.EventsWorksharedOperationProgressChangedEventArgs
Autodesk.Revit.DB.EventsDocumentSaveToLocalProgressChangedEventArgs
SystemEventArgs
Autodesk.Revit.DB.EventsRevitAPIEventArgs
Autodesk.Revit.DB.EventsRevitAPISingleEventArgs
Autodesk.Revit.DB.EventsWorksharedOperationProgressChangedEventArgs
Autodesk.Revit.DB.EventsDocumentSaveToLocalProgressChangedEventArgs
Namespace: Autodesk.Revit.DB.Events
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
public class DocumentSaveToLocalProgressChangedEventArgs : WorksharedOperationProgressChangedEventArgs
Public Class DocumentSaveToLocalProgressChangedEventArgs Inherits WorksharedOperationProgressChangedEventArgs
public ref class DocumentSaveToLocalProgressChangedEventArgs : public WorksharedOperationProgressChangedEventArgs
type DocumentSaveToLocalProgressChangedEventArgs = class inherit WorksharedOperationProgressChangedEventArgs end
The DocumentSaveToLocalProgressChangedEventArgs type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | BeforeSaveToCentral | True if the "save to local" operation is occurring before "save to central"; false if after. |
| Cancellable |
Indicates whether an event may be cancelled by an event delegate.
(Inherited from RevitAPIEventArgs) |
| FinishedStreams | The number of streams finished since the last time this event was raised. |
| IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from RevitAPIEventArgs) |
| Location |
Full path of the central model which is to be operated.
(Inherited from WorksharedOperationProgressChangedEventArgs) |
| SaveToLocalFinished | Indicates if the current "save to local" operation has finished. |
| Status |
Gets API event status, reflect current operation execution status.
(Inherited from WorksharedOperationProgressChangedEventArgs) |
| TotalStreams | The total expected number of streams to save to local. |
Methods| Name | Description | |
|---|---|---|
 | Dispose | (Inherited from RevitAPIEventArgs) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsCancelled |
Indicates whether the event is being cancelled.
(Inherited from RevitAPIEventArgs) |
| 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.
See Also