RibbonGallery インターフェイス

[アーティクル]
05/14/2013

RibbonDropDownItem オブジェクトおよび RibbonButton コントロールのメニューを表示するコントロールを表します。

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

構文

'宣言
<GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")> _
Public Interface RibbonGallery _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")]
public interface RibbonGallery : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

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

プロパティ

	名前	説明
	Buttons	この RibbonGallery のボタンのコレクションを取得します。
	ColumnCount	この RibbonGallery 内の Item 列の数を取得または設定します。
	ControlSize	RibbonGallery コントロールのサイズを取得または設定します。
	Description	メニュー上または分割ボタン上のこの RibbonGallery コントロールに表示されるテキストを取得または設定します。
	Enabled	この RibbonControl が使用可能になっているかどうかを示す値を取得または設定します。 (RibbonControl から継承されます。)
	Id	この RibbonControl オブジェクトを識別するために Microsoft Office で使用される文字列を取得します。 (RibbonControl から継承されます。)
	Image	ボタンに表示されるイメージを取得または設定します。
	ImageName	LoadImage イベントハンドラーで RibbonGallery を識別するために使用できる名前を取得または設定します。
	ItemImageSize	この RibbonGallery の項目によって表示されるイメージの寸法を指定する Size を取得または設定します。
	Items	この RibbonGallery の RibbonDropDownItem コンポーネントのコレクションを取得します。
	KeyTip	この RibbonGallery のキーボードショートカットを取得または設定します。
	Label	この RibbonGallery に表示されるテキストを取得または設定します。
	Name	この RibbonComponent の名前を取得または設定します。 (RibbonComponent から継承されます。)
	OfficeImageId	Microsoft Office の組み込みアイコンを使用する場合に、コントロールに表示するイメージを取得または設定します。
	Parent	この RibbonComponent の親を表す RibbonComponent を取得します。 (RibbonComponent から継承されます。)
	Position	ギャラリーが Microsoft Office メニュー上にある場合に、ギャラリーの位置を取得または設定します。
	Ribbon	コントロール階層を含む最上位の Ribbon オブジェクトを取得します。 (RibbonComponent から継承されます。)
	RibbonUI	インフラストラクチャ。Microsoft Office アプリケーションによってリボン機能拡張コードに提供される IRibbonUI のインスタンスを取得します。 (RibbonComponent から継承されます。)
	RowCount	この RibbonGallery が表示する RibbonDropDownItem コンポーネントの行数を取得または設定します。
	ScreenTip	ユーザーがポインターをこの RibbonGallery の上に移動したときに表示されるヒントテキストを取得または設定します。
	SelectedItem	現在選択されている項目を取得または設定します。
	SelectedItemIndex	現在選択されている RibbonDropDownItem のインデックスを取得または設定します。
	ShowImage	RibbonGallery に関連付けられているイメージが表示されるかどうかを示す値を取得または設定します。
	ShowItemImage	ギャラリー内の項目に対してイメージが表示されるかどうかを示す値を取得または設定します。
	ShowItemLabel	この RibbonGallery の項目に対してラベルが表示されるかどうかを示す値を取得または設定します。
	ShowItemSelection	現在選択されている RibbonDropDownItem を、選択されていない他の項目とは異なる表示にして区別するかどうかを示す値を取得または設定します。
	ShowLabel	この RibbonGallery のラベルが表示されるかどうかを示す値を取得または設定します。
	Site	IComponent に関連付けられた ISite を取得または設定します。 (IComponent から継承されます。)
	SuperTip	ユーザーがポインターを RibbonGallery の上に移動したときに表示される複数行のヒントテキストを取得または設定します。
	Tag	この RibbonComponent と関連付けられたアプリケーション固有のデータを取得または設定します。 (RibbonComponent から継承されます。)
	Visible	この RibbonControl が表示されるかどうかを示す値を取得または設定します。 (RibbonControl から継承されます。)

このページのトップへ

メソッド

	名前	説明
	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 から継承されます。)

このページのトップへ

イベント

	名前	説明
	ButtonClick	ユーザーがこの RibbonGallery 上のボタンをクリックすると発生します。
	Click	ユーザーがこの RibbonGallery 上の項目をクリックすると発生します。
	Disposed	コンポーネントの Disposed イベントを処理するメソッドを表します。 (IComponent から継承されます。)
	ItemsLoading	この RibbonGallery が開かれると発生します。

このページのトップへ

解説

RibbonDropDown インターフェイスと同様に、RibbonGallery は RibbonDropDownItem オブジェクトと RibbonButton コントロールのメニューを表示します。

RibbonDropDown インターフェイスとは異なり、RibbonGallery インターフェイスは、ユーザーが RibbonDropDownItem をクリックしたときに、SelectionChanged イベントではなく Click イベントを発生させます。つまり、たとえば、ユーザーが同じ RibbonDropDownItem を 2 回クリックすると、Click イベントが 2 回発生します (SelectionChanged イベントは、RibbonDropDown での同じシナリオに対し、最初の選択が行われたときに、最初のクリックの前に何が選択されているかにより、多くても 1 回しか発生しません)。

ShowItemSelection プロパティは、現在選択されている RibbonDropDownItem と選択されていない項目で表示を変えるかどうかを制御します。RibbonGallery で選択できる項目は、一度に 1 つだけです。

ItemImageSize プロパティを使用すると、16 × 16 および 32 × 32 以外のイメージサイズを指定できます。

デザイン時に RibbonDropDownItem オブジェクトを追加するには

[プロパティ] ウィンドウで Items プロパティをクリックします。
省略記号 ([...]) をクリックします。
DropDown コレクションエディターで、新しい項目の追加、順序の変更、および編集を行います。

デザイン時に、RibbonButton コントロールを RibbonGallery に追加できます。

デザイン時に RibbonButton コントロールを追加するには

[プロパティ] ウィンドウで Buttons プロパティをクリックします。
省略記号 ([...]) をクリックします。
Button コレクションエディター で、ボタンコントロールの追加、順序の変更、および編集を行います。

RibbonGallery は、RibbonFactory オブジェクトの CreateRibbonGallery メソッドを使用して実行時に作成できます。

RibbonFactory オブジェクトにアクセスするには、次の 2 つの方法があります。

リボンクラスの Factory プロパティの使用。この方法は、リボンクラス内のコードから使用します。
Globals.Factory.GetRibbonFactory メソッドの使用。この方法は、リボンクラス外のコードから使用します。

このコントロールの一部のプロパティは、実行時にリボンが Office アプリケーションに読み込まれる前、またはコントロールが動的メニューに追加される前にのみ設定できます。これらのプロパティの設定の詳細については、「リボンオブジェクトモデルの概要」を参照してください。

[!メモ]

これは、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 を参照してください。