RibbonButton クラス (2007 System)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

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

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

構文

'宣言
<ToolboxBitmapAttribute(GetType(RibbonButton), "RibbonButton.bmp")> _
Public NotInheritable Class RibbonButton _
    Inherits RibbonControl
'使用
Dim instance As RibbonButton

[ToolboxBitmapAttribute(typeof(RibbonButton), "RibbonButton.bmp")]
public sealed class RibbonButton : RibbonControl

解説

[ツールボックス] の [Office リボンコントロール] タブから Button コントロールをリボンデザイナにドラッグすると、Visual Studio Tools for Office により RibbonButton クラスのインスタンスが作成されます。

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

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

一般的なタスク

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

タスク	メンバ
実行時に、Dynamic プロパティが true に設定されているメニューにボタンを追加する。	RibbonButton コンストラクタを使用して、RibbonButton クラスのインスタンスを作成します。そのインスタンスを、メニューの 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 プロジェクトに追加します。
カスタムタブにグループを追加します。
グループにメニューを追加します。
メニューの Dynamic プロパティを true に設定します。
メニューの ItemSize プロパティを RibbonControlSizeLarge に設定します。

Private Sub AddButtonsToMenu()
    Dim tempButton As New RibbonButton()
    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 = new RibbonButton();
    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);

}