DocumentBase.Sync Property

Definition

Namespace:

Microsoft.Office.Tools.Word

Assembly:

Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Gets a Sync object that provides access to the methods and properties of documents that are part of a Document Workspace.

public:
 property Microsoft::Office::Core::Sync ^ Sync { Microsoft::Office::Core::Sync ^ get(); };

public Microsoft.Office.Core.Sync Sync { get; }

member this.Sync : Microsoft.Office.Core.Sync

Public ReadOnly Property Sync As Sync

Property Value

Sync

A Sync object that provides access to the methods and properties of documents that are part of a Document Workspace.

Examples

The following code example determines whether the document is part of a Document Workspace. If it is, the code attaches an event handler to the SyncEvent event that displays a message when the synchronization fails. To use this example, run it from the ThisDocument class in a document-level project.

private void DocumentSyncAndSyncEvent()
{
    if (this.Sync.Status ==
        Office.MsoSyncStatusType.msoSyncStatusNoSharedWorkspace)
    {
        MessageBox.Show("The document is not part of a " +
            "shared document workspace.");
        return;
    }

    this.SyncEvent +=
        new Word.DocumentEvents2_SyncEventHandler(
        ThisDocument_SyncEvent);
}

void ThisDocument_SyncEvent(Office.MsoSyncEventType SyncEventType)
{
    if (SyncEventType ==
        Office.MsoSyncEventType.msoSyncEventDownloadFailed ||
        SyncEventType ==
        Office.MsoSyncEventType.msoSyncEventUploadFailed)
    {
        MessageBox.Show("Document synchronization failed. " +
            "Please contact your administrator.");
    }
}

Private Sub DocumentSyncAndSyncEvent()
    If Me.Sync.Status = Office.MsoSyncStatusType.msoSyncStatusNoSharedWorkspace Then
        MessageBox.Show("The document is not part of a " & "shared document workspace.")
        Return
    End If
    AddHandler Me.SyncEvent, AddressOf ThisDocument_SyncEvent
End Sub

Private Sub ThisDocument_SyncEvent(ByVal SyncEventType As Office.MsoSyncEventType)
    If SyncEventType = Office.MsoSyncEventType.msoSyncEventDownloadFailed _
        OrElse SyncEventType = Office.MsoSyncEventType.msoSyncEventUploadFailed Then
        MessageBox.Show("Document synchronization failed. " & _
            "Please contact your administrator.")
    End If

End Sub