Document.Sync Event

  • Article
Word Developer Reference

Occurs when the local copy of a document that is part of a Document Workspace is synchronized with the copy on the server.

Syntax

Private Sub expression_Sync(SyncEventType)

expression   A variable that represents a Document object that has been declared using the WithEvents keyword in a class module. For information about using events with the Document object, see Using Events with the Document Object.

Parameters

Name Required/Optional Data Type Description
SyncEventType Required MsoSyncEventType The status of the document synchronization.

Example

The following example displays a message if the synchronization of a document in a Document Workspace fails.

Visual Basic for Applications 
  Private Sub Document_Sync(ByVal SyncEventType As Office.MsoSyncEventType)

If SyncEventType = msoSyncEventDownloadFailed Or _
        SyncEventType = msoSyncEventUploadFailed Then
        
    MsgBox "Document synchronization failed.  " & _
        "Please contact your administrator " & vbCrLf & _
        "or try again later."

End If



End Sub

See Also