IUIRibbon

IUIRibbon インターフェイスは Windows リボン フレームワークによって実装され、リボンの設定とプロパティを指定する機能を提供します。

リボンは、アプリケーション メニュー、クイック アクセス ツール バー (QAT)、 タブ (コアおよびコンテキスト)、グループ (コントロールのコンテナー)、および高機能なコンテキスト メニュー システム (コンテキスト ポップアップ) などの複数のコンポーネントで構成されます。

リボンの高さを取得します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

cy に返される値は、ホスト ウィンドウの幅やリボンのマークアップで宣言されたレイアウト テンプレートなど (これらに限定されません) の複数の要因に依存します。

例

次の例では、IUIRibbon::GetHeight メソッドを使用してリボンの高さを取得し、コンテキスト ポップアップ コントロールの表示位置を計算する方法を示します。

void GetDisplayLocation(POINT &pt, HWND hWnd)
{
  if (pt.x == -1 && pt.y == -1)
  {
    HRESULT hr = E_FAIL;

    // Display the menu in the upper-left corner of the client area, below the ribbon.
    IUIRibbon* pRibbon;
    hr = g_pFramework->GetView(0, IID_PPV_ARGS(&pRibbon));
    if (SUCCEEDED(hr))
    {
      UINT32 uRibbonHeight = 0;
      hr = pRibbon->GetHeight(&uRibbonHeight);
      if (SUCCEEDED(hr))
      {
        pt.x = 0;
        pt.y = uRibbonHeight;
        // Convert client coordinates of a specified point to screen coordinates.
        ClientToScreen(hWnd, &pt);
      }
      pRibbon->Release();
    }
    if (FAILED(hr))
    {
      // Default to just the upper-right corner of the entire screen.
      pt.x = 0;
      pt.y = 0;
    }
  }
}

バイナリ ストリームからリボンの設定を読み込みます。

型: HRESULT

成功した場合は S_OK を返します。シリアル化されたストリームの形式または内容が空である場合、あるいはリボン フレームワークで検証できない場合は E_FAIL を返します。

ストリームはホスト アプリケーションから提供されます。

Windows リボン フレームワークが有効なストリームを読み込めない場合は、代わりに既定のリボン レイアウトが描画されます。

LoadSettingsFromStream メソッドは、クイック アクセス ツール バー (QAT) の項目など、リボンの状態をアプリケーションのインスタンス間で永続化するのに役立ちます。

リボンの設定をバイナリ ストリームに書き込みます。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

ストリームは、適切に保存できるようホスト アプリケーションに引き渡されます。

SaveSettingsToStream メソッドは、クイック アクセス ツール バー (QAT) の項目など、リボンの状態をアプリケーションのインスタンス間で永続化するのに役立ちます。