リボンアプリケーションの作成

[アーティクル]
06/03/2023

Windows リボンフレームワークは、コントロールとそのビジュアルレイアウトを宣言する Extensible Application Markup Language (XAML) に基づくマークアップ言語と、コマンド機能とアプリケーションフックを定義するための C++ コンポーネントオブジェクトモデル (COM) ベースのインターフェイスセットという 2 つの異なる依存開発プラットフォームで構成されています。リボンフレームワークアーキテクチャ内のこの分業では、フレームワークによって提供される豊富な UI 機能を利用する開発者は、マークアップで UI を設計して記述し、リボンフレームワーク COM インターフェイスを使用してフレームワークをホストアプリケーションに接続する必要があります。

リボンのロードマップ
マークアップを記述する
- マークアップをコンパイルする
アプリケーションをビルドする
実行時の更新と実行
OLE サポート
関連トピック

リボンのロードマップ

表示されるコントロールや配置場所など、リボンアプリケーションの視覚的な側面はマークアップで宣言されます (「リボンマークアップを使用してコマンドとコントロールを宣言する」を参照してください)。ボタンが押されたときに何が起こるかなどのアプリケーションコマンドロジックは、コードに実装されます。

リボンを実装して Windows アプリケーションに組み込むプロセスには、マークアップの記述、マークアップのコンパイル、コードの記述、アプリケーション全体のコンパイルとリンクという 4 つの基本的なタスクが必要です。

次の図は、一般的なリボン実装のワークフローを示しています。

一般的なリボン実装のワークフローを示す図。

以降のセクションでは、このプロセスについて詳しく説明します。

マークアップを記述する

リボン UI を設計した後、アプリケーション開発者の最初のタスクは、リボンマークアップを使用して UI を記述することです。

重要

リボンフレームワークマークアップスキーマファイル UICC.xsd は、Windows 7 および .NET Framework 4.0 用の Microsoft Windows ソフトウェア開発キット (SDK) と共にインストールされます。標準インストールパスを使用すると、ファイルは %ProgramFiles%\Microsoft SDKs\Windows\[バージョン番号]\Bin フォルダーにあります。このフォルダーは、ヒントと自動補完を提供するために多くの XML エディターによって参照できます。

リボンコントロール、リボンコマンド (リボンコントロールの基本機能を提供するコントロールに依存しない要素)、およびすべてのコントロールレイアウトとビジュアルリレーションシップは、マークアップで宣言されます。リボンマークアップの構造は、2 つのプライマリノード階層 (コマンドとリソースツリーとビューツリー) を通じて、リボンコントロールとコマンドの違いを強調しています。

リボンによって公開されるすべてのコンテナーとアクションは、[ コマンドとリソース ] ツリーで宣言されます。各 Command 要素は、UI デザインで必要に応じて、リソースのセットに関連付けられます。

アプリケーションのコマンドを作成した後、 Views ツリーでコントロールを宣言し、各コントロールを Command にバインドしてコマンド機能を公開します。リボンフレームワークは、ここで宣言されているコントロール階層に基づいて、コントロールの実際の配置を決定します。

次のコード例は、Button コントロールを宣言し、Exit アプリケーションというラベルを付けて、Exit コマンドに関連付ける方法を示しています。

<Application xmlns="http://schemas.microsoft.com/windows/2009/Ribbon">
  <Application.Commands>
    <Command Name="cmdExit" LabelTitle="Exit application" />
  </Application.Commands>

  <Application.Views>
    <Ribbon>
      <Ribbon.Tabs>
        <Tab>
          <Group>
            <Button CommandName="cmdExit" />
          </Group>
        </Tab>
      </Ribbon.Tabs>
    </Ribbon>
  </Application.Views>
</Application>

ヒント

リボンマークアップファイルには任意のファイル名拡張子を使用することもできますが、.xmlはドキュメント全体で使用することをお勧めします。

マークアップをコンパイルする

リボンマークアップファイルを作成した後は、Windows ソフトウェア開発キット (SDK) に含まれるリボンマークアップコンパイラ UI コマンドコンパイラ (UICC) によってバイナリ形式でコンパイルする必要があります。このバイナリファイルへの参照は、ホストアプリケーションによるリボンフレームワークの初期化中に IUIFramework::LoadUI メソッドに渡されます。

UICC は、コマンドラインウィンドウから直接実行することも、Visual Studio で "カスタムビルドステップ" として追加することもできます。

次の図は、Windows 7 SDK CMD シェルウィンドウの UICC マークアップコンパイラを示しています。

コマンドラインウィンドウのuicc.exeを示すスクリーンショット。

次の図は、Visual Studio でカスタムビルドステップとして追加された UICC を示しています。

visual Studio でカスタムビルドステップとして追加uicc.exe示すスクリーンショット。

UICC は、マークアップのバイナリバージョン (.bml)、リボンホストアプリケーションにマークアップ要素を公開する ID 定義ヘッダー (.h ファイル)、リボンイメージと文字列リソースをコンパイル時にホストアプリケーションにリンクするリソース定義スクリプト (.rc ファイル) の 3 つのファイルを生成します。

リボンフレームワークマークアップのコンパイルの詳細については、「リボンマークアップのコンパイル」を参照してください。

アプリケーションをビルドする

リボンアプリケーションの準備 UI がマークアップで設計および実装されたら、フレームワークを初期化し、マークアップを使用し、マークアップで宣言されたコマンドをアプリケーション内の適切なコマンドハンドラーにバインドするアプリケーションコードを記述する必要があります。

重要

リボンフレームワークは COM ベースであるため、リボンプロジェクトでは __uuidof() 演算子を使用して、リボンフレームワークインターフェイス (IID) の GUID を参照することをお勧めします。 Microsoft 以外のコンパイラが使用されている場合やホストアプリケーションが C ベースの場合など、__uuidof() 演算子を使用できない場合は、UUID.lib に含まれていないため、アプリケーションで IID を定義する必要があります。

アプリケーションによって IID が定義されている場合は、UIRibbon.idl で指定された GUID を使用する必要があります。

UIRibbon.idl は Windows ソフトウェア開発キット (SDK) の一部として出荷されており、%ProgramFiles%\Microsoft SDKs\Windows\v7.0\Include の標準インストールパスにあります。

リボンを初期化する

次の図は、単純なリボンアプリケーションを実装するために必要な手順を示しています。

単純なリボンの実装に必要な手順を示す図。

次の手順では、単純なリボンアプリケーションを実装する方法について詳しく説明します。

Cocreateinstance

アプリケーションは、リボンフレームワーククラス ID を使用して標準の COM CoCreateInstance 関数を呼び出して、フレームワークへのポインターを取得します。

IUIFramework* pFramework = NULL;
HRESULT hr = ::CoCreateInstance(
            CLSID_UIRibbonFramework, 
            NULL,
            CLSCTX_INPROC_SERVER, 
            IID_PPV_ARGS(&pFramework));
if (FAILED(hr))
{
  return hr;
}

Initialize(hwnd, IUIApplication*)

アプリケーションは IUIFramework::Initialize を呼び出し、リボンを含む最上位ウィンドウへのハンドルと、フレームワークがアプリケーションへのコールバックを行えるようにする IUIApplication 実装へのポインターという 2 つのパラメーターを渡します。

![重要]
リボンフレームワークは、シングルスレッドアパートメント (STA) として初期化されます。
```
hr = pFramework->Initialize(hWndHost, pApplication);
if (FAILED(hr))
{
  return hr;
}
```
LoadUI(instance, resourceName)

アプリケーションは IUIFramework::LoadUI を呼び出してマークアップリソースをバインドします。この関数の最初のパラメーターは、リボンアプリケーションインスタンスへのハンドルです。 2 番目のパラメーターは、以前にコンパイルされたバイナリマークアップリソースの名前です。バイナリマークアップをリボンフレームワークに渡すことで、アプリケーションはリボン構造の内容とコントロールの配置方法を通知します。また、実行時にコマンド関連のコールバックを行うときにフレームワークによって使用される、公開するコマンドのマニフェスト (Paste、Cut、Find など) もフレームワークに提供されます。
```
hr = pFramework->LoadUI(GetModuleHandle(NULL), L"APPLICATION_RIBBON");
if (FAILED(hr))
{
  return hr;
}
```
IUIApplication::OnCreateUICommand コールバック

手順 1 から 3 が完了すると、リボンフレームワークはリボンで公開するコマンドを認識します。ただし、リボンが完全に機能する前に、フレームワークには、コマンドが実行されるタイミングをアプリケーションに通知する方法と、実行時にコマンドリソース (プロパティ) を取得する方法という 2 つのことが必要です。たとえば、コンボボックスを UI に表示する場合、フレームワークはコンボボックスを設定する項目を要求する必要があります。

これら 2 つの機能は、 IUICommandHandler インターフェイスを介して処理されます。具体的には、バイナリマークアップで宣言されているコマンドごとに (上記の手順 3 を参照)、フレームワークは IUIApplication::OnCreateUICommand を呼び出して、そのコマンドの IUICommandHandler オブジェクトをアプリケーションに要求します。

Note

IUICommandHandler インターフェイスを使用すると、Command ハンドラーを 1 つ以上の Commands にバインドできます。

少なくとも、アプリケーションは、次の例に示すように、E_NOTIMPLを返す IUIApplication メソッドスタブを実装する必要があります。

STDMETHOD(OnViewChanged)(UINT32 viewId,
                         UI_VIEWTYPE typeID,
                         IUnknown *view,
                         UI_VIEWVERB verb,
                         INT32 uReasonCode)
{ 
  return E_NOTIMPL; 
}

STDMETHOD(OnCreateUICommand)(UINT32 commandId,
                             UI_COMMANDTYPE typeID,
                             IUICommandHandler **commandHandler)
{ 
  return E_NOTIMPL; 
}

STDMETHOD(OnDestroyUICommand)(UINT32 commandId,
                              UI_COMMANDTYPE typeID,
                              IUICommandHandler *commandHandler) 
{ 
  return E_NOTIMPL; 
}

マークアップをアプリケーションにリンクする

この時点で、マークアップリソースファイルは、マークアップリソース定義ファイル (マークアップヘッダーファイルへの参照を含む) への参照をアプリケーションリソースファイルに含めることで、ホストアプリケーションにリンクする必要があります。たとえば、ribbonUI.rc というリソースファイルを持つ RibbonApp というアプリケーションでは、RibbonApp.rc ファイルに次の行が必要です。

#include "ribbonUI.rc"

使用されているコンパイラとリンカーによっては、リボンアプリケーションをコンパイルする前に、リソース定義スクリプトのコンパイルが必要になる場合もあります。このタスクには、Microsoft Visual Studio と Windows SDK に付属するリソースコンパイラ (RC) コマンドラインツールを使用できます。

アプリケーションをコンパイルする

リボンアプリケーションをコンパイルしたら、それを実行し、UI をテストできます。 UI で調整が必要で、コアアプリケーションコード内の関連する Command ハンドラーに変更がない場合は、マークアップソースファイルを修正し、マークアップを UICC.exeで再コンパイルし、新しいマークアップリソースファイルをリンクします。アプリケーションが再起動されると、変更された UI が表示されます。

これはすべて、コアアプリケーションコードに触れることなく可能です。これは、標準のアプリケーションの開発と配布よりも大幅に改善されています。

実行時の更新と実行

リボンフレームワークの実行時通信構造は、プッシュおよびプル (双方向呼び出し元) モデルに基づいています。

このモデルを使用すると、フレームワークは Command の実行時にアプリケーションに通知し、フレームワークとアプリケーションの両方でプロパティ値とリボンリソースのクエリ、更新、無効化を行うことができます。この機能は、さまざまなインターフェイスとメソッドを通じて提供されます。

フレームワークは、 IUICommandHandler::UpdateProperty コールバックメソッドを使用して、リボンアプリケーションから更新されたプロパティ情報をプルします。更新する Command プロパティを識別する Command ID とプロパティキーがメソッドに渡され、そのプロパティキーの値がフレームワークに返されるか、プッシュされます。

フレームワークは、コマンドの実行時に IUICommandHandler::Execute を呼び出し、コマンド ID と発生した実行の種類 (UI_EXECUTIONVERB) の両方を識別します。ここで、アプリケーションはコマンドの実行ロジックを指定します。

次の図は、フレームワークとアプリケーション間のコマンド実行の実行時通信を示しています。

リボンフレームワークとホストアプリケーション間の実行時通信の例を示す図。

注意

IUICommandHandler::UpdateProperty 関数と IUICommandHandler::Execute 関数を実装する必要はありません。ただし、これらのメソッドは、ユーザーがコマンドを実行したときにアプリケーションが正しく機能することを確認するために必要です。

OLE サポート

リボンアプリケーションは、OLE サーバーとして構成して、配置外の OLE アクティブ化をサポートできます。

OLE サーバーアプリケーションで作成されたオブジェクトは、OLE クライアントアプリケーション (またはコンテナー) に挿入 (貼り付けまたは配置) したときに、サーバーアプリケーションとの関連付けを維持します。インプレース OLE アクティブ化では、クライアントアプリケーションでオブジェクトをダブルクリックすると、サーバーアプリケーションの専用インスタンスが開き、編集用にオブジェクトが読み込まれます。サーバーアプリケーションを閉じると、オブジェクトに加えられたすべての変更がクライアントアプリケーションに反映されます。

注意

リボンフレームワークでは、インプレース OLE アクティブ化はサポートされていません。リボンベースの OLE サーバーで作成されたオブジェクトは、OLE クライアントアプリケーション内から編集できません。サーバーアプリケーションの外部専用インスタンスが必要です。

リボンマークアップを使用してコマンドとコントロールを宣言する
リボンユーザーエクスペリエンスのガイドライン
リボンデザインプロセス

次の方法で共有

リボンアプリケーションの作成

リボンのロードマップ

マークアップを記述する

マークアップをコンパイルする

アプリケーションをビルドする

リボンを初期化する

マークアップをアプリケーションにリンクする

アプリケーションをコンパイルする

実行時の更新と実行

OLE サポート

フィードバック

その他のリソース

次の方法で共有

リボン アプリケーションの作成

リボン のロードマップ

マークアップを記述する

マークアップをコンパイルする

アプリケーションをビルドする

リボンを初期化する

マークアップをアプリケーションにリンクする

アプリケーションをコンパイルする

実行時の更新と実行

OLE サポート

関連トピック

フィードバック

その他のリソース

リボンアプリケーションの作成

リボンのロードマップ