Application.DocumentSync 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_DocumentSync(Doc, SyncEventType)

expression   A variable that represents an Application object declared using the WithEvents keyword in a class module.

Parameters

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

Remarks

For information about using events with the Application object, see Using Events with the Application Object.

Example

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

Visual Basic for Applications 
  Private Sub app_DocumentSync(ByVal Doc As Document, _
        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