DocumentSaveToCentralProgressChangedEventArgs
The event arguments used during the save to central 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.DataTransferProgressChangedEventArgs
Autodesk.Revit.DB.Events.DocumentSaveToCentralProgressChangedEventArgs
Namespace: Autodesk.Revit.DB.Events
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class DocumentSaveToCentralProgressChangedEventArgs : DataTransferProgressChangedEventArgsThe DocumentSaveToCentralProgressChangedEventArgs 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
FailureDueToConflicts
Indicates the ‘save to central’ failure is caused by submission conflicts, that is because another one finished saving to central first.
Public Property
FinishedSize
The transferred data size, in bytes, since the last time this event was raised.
(Inherited from DataTransferProgressChangedEventArgs)
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
RetryTimes
The number of times Revit has tried to Save to Central.” Its value is ‘0’ at the first time.
Public Property
SaveToCentralFinished
Indicates if current ‘save to central’ is finished.
Public Property
Speed
Speed(bytes/second) in this event.
(Inherited from DataTransferProgressChangedEventArgs)
Public Property
Status
Gets API event status, reflect current operation execution status.
(Inherited from WorksharedOperationProgressChangedEventArgs)
Public Property
TotalSize
Total expected data size to transfer, in bytes.
(Inherited from DataTransferProgressChangedEventArgs)
Public Property
TransferMode
Data transfer mode in this event.
(Inherited from DataTransferProgressChangedEventArgs)
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 ‘DocumentSaveToCentralProgessChangedEventArgs’ released since 2017 Subscription Update.