Application.DocumentSync Event (Word)

Office 2013 and later
GitHub-Mark-64px

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

This object or member has been deprecated, but it remains part of the object model for backward compatibility. You should not use it in new applications.

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.

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

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
Show: