[方法] VBA を使用してリボンに独自のコマンドを追加する

[アーティクル]
09/24/2014

適用対象: Office 2010 | Project 2010 | Project Server 2010 | SharePoint Server 2010

ここでは、Microsoft Project 2010 で VBA を使用して、Fluent ユーザーインターフェイス (リボン) に独自のタブとコマンドをプログラムによって追加する方法を説明します。この独自のボタンをクリックすると、プロジェクト内でマクロが呼び出され、手動でスケジュールを設定したタスクの [タスク名] セルの色が切り替わります。VBA コードは、特定のプロジェクトに使用したり、ローカルコンピューター上で作成するまたは開くすべてのプロジェクトに対するリボンを変更するようにグローバルプロジェクトテンプレートに追加したりできます。

Project 2010 では、他の Microsoft Office 2010 アプリケーションと同様に、リボンのある Fluent ユーザーインターフェイスが使用されます。[Project のオプション] ダイアログボックスの [リボンのユーザー設定] タブを使用して、タブ、グループ、またはボタンを手動でリボンに追加できます。[Project のオプション] ダイアログボックスを開くには、Backstage ビューで [オプション] をクリックします。

Project 2010 のファイルはバイナリ形式なので、リボンをプログラムによって変更するには、VBA の SetCustomUI メソッドを使用する必要があります。また、Project 2010 用のマネージコードアドインの開発には、プライマリ相互運用機能アセンブリ (PIA) のオブジェクトモデルを使用できます。PIA のパスは、C:\Program Files (x86)\Microsoft Visual Studio 10.0\Visual Studio Tools for Office\PIA\Office14\Microsoft.Office.Interop.MSProject.dll です。

ヒント

PIA の SetCustomUI メソッドを使用してマネージコードアドインを開発することもできますが、Project 2010 では Microsoft Visual Studio 2010 のリボンデザイナーもサポートされているので、このデザイナーを使用して独自のタブ、グループ、またはその他のリボンコントロールを作成する方が簡単です。この記事の VBA マクロと同じジョブを実行する例については、「[方法] マネージコードを使用してカスタムコマンドをリボンに追加する」を参照してください。

SetCustomUI メソッドの詳細については、Project 2010 で VBA ヘルプを参照してください。リボンを変更する XML コマンドの詳細については、「Office Fluent ユーザーインターフェイスデベロッパーポータル」を参照してください。

手順 1. テスト用のプロジェクトとマクロを作成するには

独自のリボンをテストするためのプロジェクトを作成します。たとえば、"Toggle Cell Color for Manual Tasks" という名前のプロジェクトを作成します。
Visual Basic Editor (VBE) を開き、[プロジェクト] ウィンドウの [VBAProject] ノードを展開してから [ThisProject] をダブルクリックしてコードページを開きます。

テストに使用するマクロを作成します。この例では、ToggleManualTasksColor という名前のマクロを使用しますが、別の名前でもかまいません。

    Option Explicit

    Sub ToggleManualTasksColor()
        Dim tsks As Tasks
        Dim t As Task
        Dim rgbColor As Long

        Set tsks = ActiveProject.Tasks

        For Each t In tsks
            If (Not t Is Nothing) And (Not t.Summary) Then
                SelectTaskField Row:=t.ID, Column:="Name", rowrelative:=False
                rgbColor = ActiveCell.CellColorEx

                If t.Manual Then
                    ' Check whether the manual task color is white.
                    If rgbColor = &HFFFFFF Then
                        Font32Ex CellColor:=&HF0D9C6  ' Change the background to light blue.
                    Else
                        Font32Ex CellColor:=&HFFFFFF  ' Change the background to white.
                    End If
                Else
                    ' The task is automatically scheduled, so change the background to white.
                    Font32Ex CellColor:=&HFFFFFF
                End If
            End If
        Next t
    End Sub

ToggleManualTasksColor マクロでは、FontEx メソッドではなく Project 2010 の新しい Font32Ex メソッドを使用するので、色を 16 進数の RGB 値で表現できます。

注意

Project 2010 では、16 進数の色は B-G-R の順序で表現します。たとえば、&HFF0000 は純粋な青です。値を 10 進数で表現することもできますが (たとえば 16 進数のライトブルーの値 &HF0D9C6 は 10 進数で 15784390)、16 進数値を使用する方が色を確認するのが簡単です。

自動的にスケジュールを設定したタスクと手動でスケジュールを設定したタスクをいくつかプロジェクトに追加して、マクロを実行し、機能することを確認します。

手順 2. では、このマクロを実行するためにリボンを変更します。

手順 2. リボンを変更するマクロを作成するには

SetCustomUI メソッドの ribbonXml 引数に使用する XML データを作成します。複雑なリボン変更を行う XML を正しく作成するには、XML エディターを使用すると便利です。たとえば、以下の XML の作成には Microsoft Visual Studio を使用しました。
```
<mso:customUI xmlns:mso="http:="//schemas.microsoft.com/office/2009/07/customui">
  <mso:ribbon>
    <mso:qat/>
    <mso:tabs>
      <mso:tab id="highlightTab" label="Highlight=" insertBeforeQ="mso:TabFormat">
        <mso:group id="testGroup" label="Test" autoScale="true=">
          <mso:button id="highlightManualTasks" label="Toggle Manual Task Color"
                      imageMso="DiagramTargetInsertClassic=" onAction="ToggleManualTasksColor="/>
        </mso:group>
      </mso:tab>
    </mso:tabs>
  </mso:ribbon>
</mso:customUI>
```
Project 2010 のリボンに適用すると、この XML データは以下の操作を行います。
- mso:qat 要素は空なので、クイックアクセスツールバーは変更されません。
- mso:tab 要素は、[Highlight] という名前でタブを作成し、それをリボンの [Format] タブに挿入します。id 属性は任意の一意の英数字であり、空白を含むことはできません。id 属性は、特定のタブを参照する他のアクションで使用できます。
- mso:group 要素は、[Test] という名前でグループを [Highlight] タブに作成します。
- mso:button 要素は、Microsoft Office のアイコンコレクションにある DiagramTargetInsertClassic という名前のイメージを使用する、[Toggle Manual Task Color] ボタンを作成します。このボタンをクリックすると、OnAction 属性で指定した ToggleManualTasksColor マクロが実行されます。
  ヒント
  
  イメージを使用するには、以下のいずれかの方法を使用できます。
  - [Project のオプション] ダイアログボックスの [リボンのユーザー設定] タブで、リボン上の既存のグループの 1 つにコマンドを追加し、そのコマンドの名前を変更します。次に、アイコンを設定し、このカスタマイズを ProjectCustomizations.exportedUI という名前のファイルにエクスポートします。XML 構造をわかりやすく表示するには、ファイルの内容を Visual Studio 内で XML ファイルにコピーし、ファイル全体に書式を設定します (Ctrl+E キーを押してから、D キーを押します)。イメージ名は、追加したコマンドの imageMso 属性の値です。
  - 2007 Office System Add-In: Icons Gallery (英語) をダウンロードし、このギャラリーを Microsoft Excel で開きます。
  - Microsoft Office 2010 アプリケーションで使用できるアイコンおよびアイコン名を確認するには、Office 2010 Add-In: Icons Gallery (英語) をダウンロードしてください。
  - アイコンを作成し、そのファイル名とパスを使用します。

SetCustomUI メソッドを実行するマクロを作成します。以下の AddHighlightRibbon マクロでは、各 XML 行を ribbonXml 変数の 1 行にコピーし、XML 行に含まれる引用符にもう 1 つの引用符を追加して、ribbonXml 文字列に引用符そのものが含まれるようにします。コードを読みやすくするために、XML の書式をできるだけ実用重視で維持します。

    Private Sub AddHighlightRibbon()
        Dim ribbonXml As String

        ribbonXml = "<mso:customUI xmlns:mso=""https://schemas.microsoft.com/office/2009/07/customui"">"
        ribbonXml = ribbonXml + "  <mso:ribbon>"
        ribbonXml = ribbonXml + "    <mso:qat/>"
        ribbonXml = ribbonXml + "    <mso:tabs>"
        ribbonXml = ribbonXml + "      <mso:tab id=""highlightTab"" label=""Highlight"" insertBeforeQ=""mso:TabFormat"">"
        ribbonXml = ribbonXml + "        <mso:group id=""testGroup"" label=""Test"" autoScale=""true"">"
        ribbonXml = ribbonXml + "          <mso:button id=""highlightManualTasks"" label=""Toggle Manual Task Color"" "
        ribbonXml = ribbonXml + "imageMso=""DiagramTargetInsertClassic"" onAction=""ToggleManualTasksColor""/>"
        ribbonXml = ribbonXml + "        </mso:group>"
        ribbonXml = ribbonXml + "      </mso:tab>"
        ribbonXml = ribbonXml + "    </mso:tabs>"
        ribbonXml = ribbonXml + "  </mso:ribbon>"
        ribbonXml = ribbonXml + "</mso:customUI>"

        ActiveProject.SetCustomUI (ribbonXml)
    End Sub

AddHighlightRibbon マクロを実行して、正しく動作するかどうかを確認します。

ヒント

リボンのカスタマイズを削除するには、パラメーターに空の mso:ribbon 要素を指定して SetCustomUI を実行する次のようなマクロを作成します。ribbonXml = "<mso:customUI xmlns:mso=""https://schemas.microsoft.com/office/2009/07/customui"">" & "<mso:ribbon></mso:ribbon></mso:customUI>"

手順 3. では、このテスト用プロジェクトを開いたときに AddHighlightRibbon マクロを実行する方法について説明します。ローカルコンピューター上のすべてのプロジェクトに対してこのマクロを実行するには、手順 4. を参照してください。

手順 3. プロジェクトを開いたときにリボンを変更するには

以下のような Project_Open イベントハンドラーを追加します。

    Private Sub Project_Open(ByVal pj As Project)
        AddHighlightRibbon
    End Sub

テスト用プロジェクトを保存して閉じます。
テスト用プロジェクトを再度開きます。

テスト用オブジェクトを開くと、Project_Open マクロによって AddHighlightRibbon マクロが実行されます。このマクロが [Highlight] タブをリボンに追加します。[Highlight] タブの [Toggle Manual Task Color] をクリックすると、手動でスケジュールを設定したタスクの背景色が変更されます (図 1)。

図 1. 独自のリボンコマンドを使用する

カスタムリボンコマンドの使用

手順 3. で、[Highlight] タブが追加されるのは、マクロコードを含む特定のテスト用プロジェクトを開いたときのみです。手順 4. では、ローカルコンピューター上で作成するまたは開くすべてのプロジェクトに対するリボンを変更するようにグローバルプロジェクトテンプレートでマクロを使用する方法について説明します。

手順 4. すべてのローカルプロジェクトに対するリボンを変更するには

VBE を開き、[プロジェクト] 作業ウィンドウで [ProjectGlobal] ノードを展開します。次に、[ThisProject (Global.MPT)] をダブルクリックして、グローバルプロジェクトテンプレートのコードページを開きます。
例に示されているすべてのコードを [ThisProject (Global.MPT)] コードページにコピーします。
イベントハンドラーを、以下のように Project_Open イベントから Project_Activate イベントに変更します。
```
    Private Sub Project_Activate(ByVal pj As MSProject.Project)
        AddHighlightRibbon
    End Sub
```
現在のプロジェクトを保存して、Project 2010 を終了します。
Project 2010 を起動して、新しい空のプロジェクトを作成します。

新しいプロジェクトが作成されたとき、またはプロジェクトが開いたときに、Global.MPT 内の Project_Activate イベントハンドラーによって、手順 3. のように AddHighlightRibbon マクロが実行されます。

テスト用プロジェクトに Project_Open イベントハンドラーと関連マクロを残してある場合、そのテスト用プロジェクトを開くと、まず Project_Open イベントハンドラーが実行され、その後で Global.MPT 内の Project_Activate イベントハンドラーが実行されます。イベントの実行順序は、次の例のように、イベントハンドラーにメッセージボックスステートメントを追加することで簡単に把握できます。

    Private Sub Project_Open(ByVal pj As Project)
        If (Not pj Is Nothing) Then
            MsgBox "Opening project: " & pj.Name
        End If
        
        AddHighlightRibbon
    End Sub

イベントハンドラーを特定のプロジェクトから Global.MPT にコピーする場合は、元のプロジェクトからそのイベントハンドラーを削除することをお勧めします。

注意

イベントハンドラーによって、SetCustomUI メソッドで別のリボン変更を行う 2 番目のマクロが呼び出されると、その 2 番目の呼び出しにより最初の呼び出しがオーバーライドされます。最初のリボン変更と 2 番目のリボン変更の両方を行うには、ribbonXml パラメーターの XML データを結合して 1 つの SetCustomUI 呼び出しにする必要があります。

例

以下のコードは、Project_Open イベントハンドラーを使用している、このテスト用プロジェクトの完全な VBA コード例です。

    Option Explicit
    
    Sub ToggleManualTasksColor()
        Dim tsks As Tasks
        Dim t As Task
        Dim rgbColor As Long
        
        Set tsks = ActiveProject.Tasks
        
        For Each t In tsks
            If (Not t Is Nothing) And (Not t.Summary) Then
                SelectTaskField Row:=t.ID, Column:="Name", rowrelative:=False
                rgbColor = ActiveCell.CellColorEx
            
                If t.Manual Then
                    ' Check whether the manual task color is white.
                    If rgbColor = &HFFFFFF Then
                        Font32Ex CellColor:=&HF0D9C6  ' Change the background to light blue.
                    Else
                        Font32Ex CellColor:=&HFFFFFF  ' Change the background to white.
                    End If
                Else
                    ' The task is automatically scheduled, so change the background to white.
                    Font32Ex CellColor:=&HFFFFFF
                End If
            End If
        Next t
    End Sub
    
    Private Sub Project_Open(ByVal pj As Project)
        AddHighlightRibbon
    End Sub
    
    
    Private Sub AddHighlightRibbon()
        Dim ribbonXml As String
        
        ribbonXml = "<mso:customUI xmlns:mso=""https://schemas.microsoft.com/office/2009/07/customui"">"
        ribbonXml = ribbonXml + "  <mso:ribbon>"
        ribbonXml = ribbonXml + "    <mso:qat/>"
        ribbonXml = ribbonXml + "    <mso:tabs>"
        ribbonXml = ribbonXml + "      <mso:tab id=""highlightTab"" label=""Highlight"" insertBeforeQ=""mso:TabFormat"">"
        ribbonXml = ribbonXml + "        <mso:group id=""testGroup"" label=""Test"" autoScale=""true"">"
        ribbonXml = ribbonXml + "          <mso:button id=""highlightManualTasks"" label=""Toggle Manual Task Color"" "
        ribbonXml = ribbonXml + "imageMso=""DiagramTargetInsertClassic"" onAction=""ToggleManualTasksColor""/>"
        ribbonXml = ribbonXml + "        </mso:group>"
        ribbonXml = ribbonXml + "      </mso:tab>"
        ribbonXml = ribbonXml + "    </mso:tabs>"
        ribbonXml = ribbonXml + "  </mso:ribbon>"
        ribbonXml = ribbonXml + "</mso:customUI>"
        
        ActiveProject.SetCustomUI (ribbonXml)
    End Sub

セキュリティ

マクロセキュリティを設定するには、Backstage ビュー (リボンの [ファイル] タブ上) で [オプション] をクリックし、以下の操作を行います。

[Project のオプション] ダイアログボックスの [セキュリティセンター] タブをクリックし、[セキュリティセンターの設定] をクリックします。
[セキュリティセンター] ダイアログボックスの [マクロの設定] タブをクリックします。
署名されていないマクロをテストするために、[警告を表示してすべてのマクロを無効にする] をオンにし、[OK] をクリックし、さらに [OK] をクリックします。

署名されていないマクロを実行しようとすると、[Microsoft Project のセキュリティに関する通知] ダイアログボックスが表示されます。[マクロを有効にする] をクリックして、マクロをプロジェクトで実行します。

ヒント

マクロプロジェクトにデジタル署名を追加すると、[Microsoft Project のセキュリティに関する通知] ダイアログボックスを表示せずにプロジェクトを開くことができます。「マクロプロジェクトにデジタル署名を追加する」は、Project 2010 を含めて、VBA を使用するすべての Microsoft Office 2010 製品に適用されます。

次の方法で共有

[方法] VBA を使用してリボンに独自のコマンドを追加する

手順 1. テスト用のプロジェクトとマクロを作成するには

手順 2. リボンを変更するマクロを作成するには

手順 3. プロジェクトを開いたときにリボンを変更するには

手順 4. すべてのローカルプロジェクトに対するリボンを変更するには

例

セキュリティ

関連項目

タスク

参照

その他のリソース

その他のリソース

次の方法で共有

[方法] VBA を使用してリボンに独自のコマンドを追加する

手順 1. テスト用のプロジェクトとマクロを作成するには

手順 2. リボンを変更するマクロを作成するには

手順 3. プロジェクトを開いたときにリボンを変更するには

手順 4. すべてのローカル プロジェクトに対するリボンを変更するには

例

セキュリティ

関連項目

タスク

参照

その他のリソース

その他のリソース

手順 4. すべてのローカルプロジェクトに対するリボンを変更するには