RibbonOfficeMenu インターフェイス

Microsoft Office メニューに追加したコントロールにアクセスできるようにします。

名前空間:  Microsoft.Office.Tools.Ribbon
アセンブリ:   Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll 内)
  Microsoft.Office.Tools.Common.v4.0.Utilities (Microsoft.Office.Tools.Common.v4.0.Utilities.dll 内)

構文

'宣言
<GuidAttribute("49cea6a9-3670-4ae0-9a36-9305e27f302b")> _
Public Interface RibbonOfficeMenu _
    Inherits RibbonComponent, IComponent, IDisposable
[GuidAttribute("49cea6a9-3670-4ae0-9a36-9305e27f302b")]
public interface RibbonOfficeMenu : RibbonComponent, 
    IComponent, IDisposable

RibbonOfficeMenu 型で公開されるメンバーは以下のとおりです。

プロパティ

  名前 説明
パブリック プロパティ Items Microsoft Office メニューに追加したリボン コントロールを取得します。
パブリック プロパティ Name この RibbonComponent の名前を取得または設定します。 (RibbonComponent から継承されます。)
パブリック プロパティ Parent この RibbonComponent の親を表す RibbonComponent を取得します。 (RibbonComponent から継承されます。)
パブリック プロパティ Ribbon コントロール階層を含む最上位の Ribbon オブジェクトを取得します。 (RibbonComponent から継承されます。)
パブリック プロパティ RibbonUI インフラストラクチャ。Microsoft Office アプリケーションによってリボン機能拡張コードに提供される IRibbonUI のインスタンスを取得します。 (RibbonComponent から継承されます。)
パブリック プロパティ Site IComponent に関連付けられた ISite を取得または設定します。 (IComponent から継承されます。)
パブリック プロパティ Tag この RibbonComponent と関連付けられたアプリケーション固有のデータを取得または設定します。 (RibbonComponent から継承されます。)

このページのトップへ

メソッド

  名前 説明
パブリック メソッド Dispose アンマネージ リソースの解放およびリセットに関連付けられているアプリケーション定義のタスクを実行します。 (IDisposable から継承されます。)
パブリック メソッド PerformDynamicLayout RibbonComponent に動的メニューなどの動的な親があり、レイアウトが中断されていない場合、親コントロールの Microsoft.Office.Core.IRibbonUI.InvalidateControl メソッドを呼び出します。 (RibbonComponent から継承されます。)
パブリック メソッド PerformLayout RibbonComponent に親があり、レイアウトが中断されていない場合、Microsoft.Office.Core.IRibbonUI.InvalidateControl を呼び出します。 (RibbonComponent から継承されます。)
パブリック メソッド ResumeLayout() SuspendLayout メソッドの実行結果を元に戻します。 (RibbonComponent から継承されます。)
パブリック メソッド ResumeLayout(Boolean) SuspendLayout メソッドの実行結果を元に戻します。 (RibbonComponent から継承されます。)
パブリック メソッド SuspendLayout Microsoft Office アプリケーションがリボン上のコントロールの状態を更新しないようにします。 (RibbonComponent から継承されます。)

このページのトップへ

イベント

  名前 説明
パブリック イベント Disposed コンポーネントの Disposed イベントを処理するメソッドを表します。 (IComponent から継承されます。)

このページのトップへ

解説

リボン (ビジュアル デザイナー) 項目をプロジェクトに追加すると、Visual Studio によって、生成される OfficeRibbon インターフェイスの OfficeMenu プロパティに新しい RibbonOfficeMenu オブジェクトが自動的に割り当てられます。実行時に Microsoft Office メニューに新しいコントロールを追加したり、Microsoft Office メニューに追加したコントロールにアクセスしたりするには、このオブジェクトを使用します。

実行時にコントロールを追加できます。ただし、リボンが読み込まれる前に行う必要があります。コントロールのインスタンスを作成した後、新しいコントロールを Items コレクションに追加します。詳細については、「リボン オブジェクト モデルの概要」を参照してください。

[!メモ]

これは、Visual Studio Tools for Office Runtime によって実装されたインターフェイスです。コードに実装されるものではありません。詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。

使用方法

ここでは、.NET Framework 4 および .NET Framework 4.5 を対象とする Office プロジェクトで使用される型のバージョンについて説明します。.NET Framework 3.5 を対象とするプロジェクトでは、この型のメンバーが異なること、およびこのコード例が動作しないことがあります。.NET Framework 3.5 を対象とするプロジェクトの型の詳細については、Visual Studio 2008 ドキュメントの参照セクション https://go.microsoft.com/fwlink/?LinkId=160658 を参照してください。

次の例では、Office のリボン メニューのカスタム コントロールを反復処理してメニュー名を表示します。このコード例を実行するには、最初に次の手順を実行する必要があります。

  1. [リボン (ビジュアル デザイナー)] アイテムを Office プロジェクトに追加します。

  2. ボタンを Microsoft Office ボタンに追加します。

  3. ボタンの (Name) プロパティを myOfficeMenuButton に設定します。

  4. Position プロパティにある AfterOfficeIDPositionType プロパティを設定します。

  5. Position プロパティにある FilePrintMenuOfficeID プロパティを設定します。

Private Sub ListOfficeRibbonCustomControls()
    System.Windows.Forms.MessageBox.Show( _
            "Listing all Office Menu custom controls...")
    For Each control As RibbonComponent In Globals.Ribbons.Ribbon1.OfficeMenu.Items
        System.Windows.Forms.MessageBox.Show("Control name: " + control.Name)
    Next
End Sub
private void ListOfficeRibbonCustomControls()
{
    System.Windows.Forms.MessageBox.Show(
        "Listing all Office Menu custom controls...");
    foreach (RibbonComponent control in Globals.Ribbons.Ribbon1.OfficeMenu.Items)
    {
        System.Windows.Forms.MessageBox.Show("Control name: " + control.Name);
    }
}

参照

関連項目

Microsoft.Office.Tools.Ribbon 名前空間

その他の技術情報

方法: Backstage ビューにコントロールを追加する

リボン オブジェクト モデルの概要