2027 Class
Changes 0
C

WorksharedOperationProgressChangedEventArgs

Description:
The event arguments used by the WorksharedOperationProgressChanged event, this event will be raised when executing following workshared operations.
Remarks:
Remarks

For synchronizing with central operation, there are 4 steps. 1) Save to local (before save to central) - Serializes the streams from memory to local disk cache; [!:Autodesk::Revit::DB::Events::DocumentSaveToLocalProgressChangedEventArgs] 2) Reload latest - Downloads the streams from central model on server and merge them into local memory; [!:Autodesk::Revit::DB::Events::DocumentReloadLatestProgressChangedEventArgs] 3) Save to central - Uploads merged streams from local memory to server central model; [!:Autodesk::Revit::DB::Events::DocumentSaveToCentralProgressChangedEventArgs] 4) Save to local (after save to central) - Serializes the merged streams from memory to local disk cache; [!:Autodesk::Revit::DB::Events::DocumentSaveToLocalProgressChangedEventArgs]

For document open operation, just download the model from server and then open it; [!:Autodesk::Revit::DB::Events::CreateRelatedFileProgressChangedEventArgs]

It is NOT recommended to deal with time-consuming work when handling WorksharedOperationProgressChanged event, otherwise it would increase synchronizing with central or model open time.

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.DocumentSaveToLocalProgressChangedEventArgs
Name Return Type Description Inherited From
M Dispose() None (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M IsCancelled() Boolean Indicates whether the event is being cancelled. (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P Cancellable bool Indicates whether an event may be cancelled by an event delegate. (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity. (Inherited from RevitAPIEventArgs ) RevitAPIEventArgs
P Location string Full path of the central model which is to be operated.
P Status RevitAPIEventStatus Gets API event status, reflect current operation execution status.