VBAのSyncプロパティ

こちらでは、エクセルVBAのSyncプロパティの解説になります。

プロパティとはオブジェクトの属性を指します。属性とは、そのオブジェクトの情報そのものです。プロパティはその値を取得したり、設定することもできます。プロパティを利用するにはオブジェクト名とプロパティ名の間に「.(ピリオド)」で結んで記述します。

オブジェクト名.プロパティ名

また、プロパティを設定する場合は以下のように「=(イコール)」を記述し設定値を代入します。

オブジェクト名.プロパティ名 = 設定値

Syncプロパティ

Syncプロパティは、ドキュメントワークスペースに含まれているワークシートのローカルコピーがサーバー上のコピーと同期されたときに発生します。

Private Sub object_Sync(SyncEventType)
object クラスモジュール内で WithEvents キーワードを使用して宣言された Workbook 型のオブジェクトを指定します。
SyncEventType MsoSyncEventType クラスの定数を使用します。ワークシートの同期の状態を示します。
使用できる定数は、次に示す msoSyncEventType クラスのいずれかです。

msoSyncEventDownloadFailed
msoSyncEventDownloadInitiated
msoSyncEventDownloadNoChange
msoSyncEventDownloadSucceeded
msoSyncEventOffline
msoSyncEventUploadFailed
msoSyncEventUploadInitiated
msoSyncEventUploadSucceeded

次の使用例は、ドキュメントワークスペース内のワークシートの同期が失敗した場合にメッセージを表示します。


Private Sub Worksheet_Sync(ByVal SyncEventType As Office.MsoSyncEventType)
    If SyncEventType = msoSyncEventDownloadFailed Or _
            SyncEventType = msoSyncEventUploadFailed Then            
        MsgBox "ドキュメントの同期が失敗しました。" & _            "管理者に問い合わせるか、" & vbCrLf & _
            "後で再試行してください。"        
End If    
End Sub

※ドラッグ(スワイプ)すると全体を確認できます。