VBAのSharedWorkspaceオブジェクト

SharedWorkspaceオブジェクト

SharedWorkspaceオブジェクトについての解説になります。

SharedWorkspaceオブジェクトとは

SharedWorkspaceオブジェクトは、SharedWorkspace

アクティブな Word ドキュメント、Excel ドキュメント、PowerPoint ドキュメントをサーバーの Windows SharePoint Services ドキュメントワークスペースに追加して、ワークスペースの共同作業機能を活用できるようにするには、SharedWorkspace オブジェクトを使用します。また、ドキュメントをワークスペースから切断したり、削除したりするときにも、SharedWorkspace オブジェクトを使用します。共有ドキュメントと関連付けるファイル、フォルダ、リンク、メンバ、タスクを管理するには、SharedWorkspace オブジェクトのコレクションを使用します。

SharedWorkspace オブジェクトモデルは、ドキュメントがワークスペースに保存されているかどうかにかかわらず使用できます。Document オブジェクト、Workbook オブジェクト、および Presentation オブジェクトの SharedWorkspace プロパティは、ドキュメントが共有されていない場合でも、Nothing を返しません。アクティブドキュメントが共有ワークスペースに保存され、接続されているかどうかを調べるには、SharedWorkspace オブジェクトの Connected プロパティを使用します。

SharedWorkspace オブジェクト階層内のオブジェクト、プロパティ、およびメソッドを使用するには、適切なアクセス許可が必要となります。

共有ワークスペースに保存されているドキュメントおよびファイルを管理するには、SharedWorkspaceFiles コレクションを使用します。このコレクションには、SharedWorkspace オブジェクトの Files プロパティを通じてアクセスできます。

共有ワークスペースのメインドキュメントライブラリフォルダの中にあるサブフォルダを管理するには、SharedWorkspaceFolders コレクションを使用します。このコレクションには、SharedWorkspace オブジェクトの Folders プロパティを通じてアクセスできます。

共有ワークスペース内のドキュメントで共同作業を行っているメンバに関係する補足ドキュメントや関連情報へのリンクを管理するには、SharedWorkspaceLinks コレクションを使用します。このコレクションには、SharedWorkspace オブジェクトの Links プロパティを通じてアクセスできます。

共有ワークスペースへの参加権限を持つユーザーを管理したり、ワークスペースに保存されている共有ドキュメントで共同作業したりするには、SharedWorkspaceMembers コレクションを使用します。このコレクションには、SharedWorkspace オブジェクトの Members プロパティを通じてアクセスできます。

共有ワークスペース内のドキュメントで共同作業しているメンバに割り当てたタスクを管理するには、SharedWorkspaceTasks コレクションを使用します。このコレクションには、SharedWorkspace オブジェクトの Tasks プロパティを通じてアクセスできます。

新しいドキュメントワークスペースを作成し、アクティブドキュメントをワークスペースに追加するには、CreateNew メソッドを使用します。ワークスペースに関する情報を取得するには、Name プロパティおよび URL プロパティを使用します。

SharedWorkspace オブジェクトは、サーバーから取得したオブジェクトおよびプロパティのローカルキャッシュを使用します。コードを開発するときは、ある処理を実行する前に、必要に応じてローカルキャッシュを更新し、ローカルでのプロパティの変更内容をサーバーに保存してください。ローカルキャッシュをサーバー側の内容で更新するには、SharedWorkspace オブジェクトの Refresh メソッドを使用します。更新が最後に実行された日時を取得するには、LastRefreshed プロパティを使用します。リンクおよびタスクのプロパティをローカルで変更した後、変更内容をサーバーにアップロードするには、SharedWorkspaceLink オブジェクトおよび SharedWorkspaceTask オブジェクトの Save メソッドを使用します。

アクティブドキュメントのローカルコピーを共有ワークスペースから切断するには、Disconnect メソッドを使用します。このとき、ワークスペース内の共有コピーはそのままの状態で残されます。共有ワークスペースから共有ドキュメントを完全に削除するには、RemoveDocument メソッドを使用します。

SharedWorkspace オブジェクト階層内のオブジェクト、プロパティ、メソッドを使用するには、適切なアクセス許可が必要です。SharedWorkspaceMembers コレクションにメンバを追加するときは、Role 引数を使用して、各ワークスペースメンバに割り当てるアクセス許可を指定します。

次の使用例は、アクティブドキュメントの接続先共有ワークスペースのプロパティの値を表示します。


    Dim swsWorkspace As Office.SharedWorkspace
    Dim strSWSInfo As String
    Set swsWorkspace = ActiveWorkbook.SharedWorkspace
    strSWSInfo = swsWorkspace.Name & vbCrLf & _
        " - URL: " & swsWorkspace.URL & vbCrLf & _
        "この共有ワークスペースには、以下のアイテムが含まれています。" & vbCrLf & _
        " - ファイル数: " & swsWorkspace.Files.Count & vbCrLf & _
        " - フォルダ数: " & swsWorkspace.Folders.Count & vbCrLf & _
        " - リンク数: " & swsWorkspace.Links.Count & vbCrLf & _
        " - メンバ数: " & swsWorkspace.Members.Count & vbCrLf & _
        " - タスク数: " & swsWorkspace.Tasks.Count & vbCrLf
    MsgBox strSWSInfo, vbInformation + vbOKOnly, _
        "共有ワークスペース情報"
    Set swsWorkspace = Nothing

SharedWorkspace オブジェクトモデルを使用した場合、SharedWorkspace オブジェクトのキャッシュとアクティブドキュメントの [共有ワークスペース] 作業ウィンドウに表示されるユーザーインターフェイスの内容が同期しないことがありえます。たとえば、[共有ワークスペース] 作業ウィンドウが開いているときに、プログラミングを通じて CreateNew メソッドを呼び出し、アクティブドキュメントを新しいワークスペースに追加した場合、[共有ワークスペース] 作業ウィンドウには [作成] ボタンが表示され続けます。このような状況の場合、内容が既に無効になっている [共有ワークスペース] 作業ウィンドウでユーザーがアイテムを何か選択すると、エラーが発生し、ドキュメントの現在の状態と共有ワークスペースのデータを同期するために更新処理が実行されます。

Document、Workbook、Presentation の各オブジェクトには、Sync オブジェクトを返す Sync プロパティも用意されています。共有ドキュメントのローカルコピーとサーバーコピーの同期を管理するには、Sync オブジェクトおよびそのプロパティとメソッドを使用します。

シート見出しの色を設定するサンプルコード

こちらでは、シート見出しの色を設定するマクロになります。


Sub sample()

    Sheets("Sheet1").Tab.ColorIndex = 3

End Sub

実行結果

解説

こちらのマクロは、SharedWorkspaceオブジェクトのColorIndexプロパティを利用しています。

SharedWorkspaceオブジェクトの親オブジェクト一覧

親オブジェクト名	内容
Chartオブジェクト	ブック内のグラフを表します。ChartObject オブジェクトに含まれている埋め込みグラフか、独立したグラフシートのどちらかのグラフです。
Worksheetオブジェクト