RibbonButton インターフェイス

リファレンス

定義

名前空間:: Microsoft.Office.Tools.Ribbon

アセンブリ:: Microsoft.Office.Tools.Common.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl

属性: GuidAttribute

実装: RibbonComponent RibbonControl IComponent IDisposable

例

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

Visual Studio の Office 開発ツールを使用して作成したプロジェクトにリボン (Visual Designer) 項目を追加します。
グループをカスタムタブに追加します。
グループにメニューを追加します。
メニューの Dynamic プロパティをに true設定します。
メニューの ItemSize プロパティを RibbonControlSizeLarge に設定します。

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);

}

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

注釈

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

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

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

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

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

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

一般的なタスク

次の表に、一般的なタスクに役立つメンバーを示します。

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

注意

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

使用

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

プロパティ

ControlSize	ボタンのサイズを取得または設定します。
Description	メニューのプロパティが Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge に設定されている場合 ItemSize に、メニューのこのボタンに表示されるテキストを取得または設定します。
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	ボタンのラベルが表示されるかどうかを示す値を取得または設定します。
SuperTip	ユーザーがポインターをボタンの上に移動したときに表示される複数行のヒントテキストを取得または設定します。
Tag	この RibbonComponent と関連付けられたアプリケーション固有のデータを取得または設定します。 (継承元 RibbonComponent)
Visible	この RibbonControl が表示されるかどうかを示す値を取得または設定します。 (継承元 RibbonControl)

メソッド

PerformDynamicLayout()	RibbonComponent に動的メニューなどの動的な親があり、レイアウトが中断されていない場合に、親コントロールの Microsoft.Office.Core.IRibbonUI.InvalidateControl メソッドを呼び出します。 (継承元 RibbonComponent)
PerformLayout()	に親があり、レイアウトが中断されていない場合に、RibbonComponentMicrosoft.Office.Core.IRibbonUI.InvalidateControl を呼び出します。 (継承元 RibbonComponent)
ResumeLayout()	SuspendLayout() メソッドの実行結果を元に戻します。 (継承元 RibbonComponent)
ResumeLayout(Boolean)	SuspendLayout() メソッドの実行結果を元に戻します。 (継承元 RibbonComponent)
SuspendLayout()	Microsoft Office アプリケーションがリボン上のコントロールの状態を更新しないようにします。 (継承元 RibbonComponent)

イベント

Click

ユーザーがボタンをクリックすると発生します。

適用対象

次の方法で共有