Sync Event [Excel 2003 VBA Language Reference]

  • Article

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

Private Subobject_Sync(SyncEventType)

object An object of type Workbook declared by using the WithEvents keyword in a class module.

SyncEventType   MsoSyncEventType. The status of the worksheet synchronization.

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 worksheet in a Document Workspace fails.

Private Sub Worksheet_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

Applies to | Workbook Object