DocumentSaveToCentralProgressChangedEventArgs Class

The event arguments used during the save to central phase of [!:Autodesk::Revit::ApplicationServices::Application::WorksharedOperationProgressChanged].
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    Autodesk.Revit.DB.EventsRevitAPIEventArgs
      Autodesk.Revit.DB.EventsRevitAPISingleEventArgs
        Autodesk.Revit.DB.EventsWorksharedOperationProgressChangedEventArgs
          Autodesk.Revit.DB.EventsDataTransferProgressChangedEventArgs
            Autodesk.Revit.DB.EventsDocumentSaveToCentralProgressChangedEventArgs

Namespace: Autodesk.Revit.DB.Events
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.0.4.0 (26.0.4.0)
Syntax
Copy
public class DocumentSaveToCentralProgressChangedEventArgs : DataTransferProgressChangedEventArgs

The DocumentSaveToCentralProgressChangedEventArgs type exposes the following members.

Properties
 NameDescription
Public propertyCancellable Indicates whether an event may be cancelled by an event delegate.
(Inherited from RevitAPIEventArgs)
Public propertyFailureDueToConflicts Indicates the 'save to central' failure is caused by submission conflicts, that is because another one finished saving to central first.
Public propertyFinishedSize The transferred data size, in bytes, since the last time this event was raised.
(Inherited from DataTransferProgressChangedEventArgs)
Public propertyIsValidObject Specifies whether the .NET object represents a valid Revit entity.
(Inherited from RevitAPIEventArgs)
Public propertyLocation Full path of the central model which is to be operated.
(Inherited from WorksharedOperationProgressChangedEventArgs)
Public propertyRetryTimes The number of times Revit has tried to Save to Central." Its value is '0' at the first time.
Public propertySaveToCentralFinished Indicates if current 'save to central' is finished.
Public propertySpeed Speed(bytes/second) in this event.
(Inherited from DataTransferProgressChangedEventArgs)
Public propertyStatus Gets API event status, reflect current operation execution status.
(Inherited from WorksharedOperationProgressChangedEventArgs)
Public propertyTotalSize Total expected data size to transfer, in bytes.
(Inherited from DataTransferProgressChangedEventArgs)
Public propertyTransferMode Data transfer mode in this event.
(Inherited from DataTransferProgressChangedEventArgs)
Top
Methods
 NameDescription
Public methodDispose
(Inherited from RevitAPIEventArgs)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIsCancelled Indicates whether the event is being cancelled.
(Inherited from RevitAPIEventArgs)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
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 'DocumentSaveToCentralProgessChangedEventArgs' released since 2017 Subscription Update.
See Also