Share via

DocumentSync Event

  • Article

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

Private Subobject_DocumentSync(Doc, SyncEventType)

object An object of type Application declared using the WithEvents keyword in a class module. For information about using events with the Application object, see Using Events with the Application Object.

Doc    Document. The document being synchronized.

MsoSyncEventType

MsoSyncEventType can be one of the following msoSyncEventType constants:

msoSyncEventDownloadFailed
msoSyncEventDownloadInitiated
msoSyncEventDownloadNoChange
msoSyncEventDownloadSucceeded
msoSyncEventOffline
msoSyncEventUploadFailed
msoSyncEventUploadInitiated
msoSyncEventUploadSucceeded

Example

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

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

Applies to | Application Object