RibbonButton インターフェイス

カスタム リボン上のボタンを表します。

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

構文

'宣言
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

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

プロパティ

	名前	説明
	ControlSize	ボタンのサイズを取得または設定します。
	Description	メニューの ItemSize プロパティが Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge に設定されているときに、メニューのこのボタンに表示されるテキストを取得または設定します。
	Enabled	この RibbonControl が使用可能になっているかどうかを示す値を取得または設定します。 (RibbonControl から継承されます。)
	Id	この RibbonControl オブジェクトを識別するために Microsoft Office で使用される文字列を取得します。 (RibbonControl から継承されます。)
	Image	ボタンに表示されるイメージを取得または設定します。
	ImageName	LoadImage イベント ハンドラーでボタンを識別するために使用できる名前を取得または設定します。
	KeyTip	ボタンのキーボード ショートカットを取得または設定します。
	Label	ボタンに表示されるテキストを取得または設定します。
	Name	この RibbonComponent の名前を取得または設定します。 (RibbonComponent から継承されます。)
	OfficeImageId	Microsoft Office の組み込みアイコンを使用する場合に、ボタン上に表示するイメージを取得または設定します。
	Parent	この RibbonComponent の親を表す RibbonComponent を取得します。 (RibbonComponent から継承されます。)
	Position	ボタンが Microsoft Office メニュー上にある場合に、ボタンの位置を取得または設定します。
	Ribbon	コントロール階層を含む最上位の Ribbon オブジェクトを取得します。 (RibbonComponent から継承されます。)
	RibbonUI	インフラストラクチャ。 Microsoft Office アプリケーションによってリボン機能拡張コードに提供される IRibbonUI のインスタンスを取得します。 (RibbonComponent から継承されます。)
	ScreenTip	ユーザーがポインターをボタンの上に移動したときに表示されるツールヒント テキストを取得または設定します。
	ShowImage	ボタンに関連付けられているイメージが表示されるかどうかを示す値を取得または設定します。
	ShowLabel	ボタンのラベルが表示されるかどうかを示す値を取得または設定します。
	Site	IComponent に関連付けられた ISite を取得または設定します。 (IComponent から継承されます。)
	SuperTip	ユーザーがポインターをボタンの上に移動したときに表示される複数行のヒント テキストを取得または設定します。
	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 から継承されます。)

このページのトップへ

イベント

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

このページのトップへ

解説

Visual Studio は、[ツールボックス] の [Office リボン コントロール] タブから Button コントロールをリボン デザイナーにドラッグすると、RibbonButton インターフェイスを実装するクラスのインスタンスを作成します。

このコントロールのインスタンスを実行時に作成して、動的メニューに追加することもできます。 Dynamic プロパティを true に設定すると、メニューは動的になります。

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

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

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

• リボン クラスの Factory プロパティの使用。 この方法は、リボン クラス内のコードから使用します。

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

一般的なタスク

一般的なタスクで有用なメンバーを次の表に示します。

Task (タスク)	メンバー
実行時に、Dynamic プロパティが true に設定されているメニューにボタンを追加する。	CreateRibbonButton を使用して、RibbonButton インターフェイスを実装するクラスのインスタンスを作成します。 RibbonFactory クラスのメソッド。 詳細については、「Office プロジェクト内のオブジェクトへのグローバル アクセス」を参照してください。 そのインスタンスを、メニューの Items コレクションに追加します。
ボタンのサイズを変更する。	ControlSize を任意の値に設定します。 たとえば、大きいボタンの場合は Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge に設定します。
ボタンにイメージを表示する。	イメージを表示するには 3 種類の方法があります。 Image プロパティを使用します。 このプロパティを使用すると最も詳細に制御できます。 OfficeImageId を、ボタンのアイコンとして表示する Microsoft Office 組み込みイメージの ID に設定します。 ImageName プロパティを LoadImage イベントと共に使用します。 このプロパティを使用すると、パフォーマンスが若干向上します。
ボタンを無効または非表示にする。	ボタンを無効にするには、Enabled を false に設定します。 ボタンを非表示にするには、Visible を false に設定します。
ユーザーがボタンをクリックしたときにコードを実行する。	Click イベント ハンドラーにコードを追加します。

注意

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

使用方法

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

例

次の例では、新しいボタンを作成し、ボタンのさまざまなプロパティを設定した後、メニューにボタンを追加します。 このコード例を実行するには、最初に次の手順を実行する必要があります。

1. [リボン (ビジュアル デザイナー)] アイテムを、Visual Studio で Office 開発ツールを使用して作成されたプロジェクトに追加します。

2. カスタム タブにグループを追加します。

3. グループにメニューを追加します。

4. メニューの Dynamic プロパティを true に設定します。

5. メニューの ItemSize プロパティを RibbonControlSizeLarge に設定します。

Private Sub AddButtonsToMenu()
    Dim tempButton = Me.Factory.CreateRibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

private void AddButtonsToMenu()
{
    RibbonButton tempButton = this.Factory.CreateRibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize =
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}

参照

参照

Microsoft.Office.Tools.Ribbon 名前空間

RibbonMenu

RibbonButton

その他の技術情報

リボンの概要

リボン デザイナー

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

方法 : リボンのカスタマイズの概要