RibbonToggleButton インターフェイス

定義

リボンのトグル ボタン コントロールを表します。

public interface class RibbonToggleButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent
[System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent
[<System.Runtime.InteropServices.Guid("fc50977f-187c-4082-ab53-087e81f4ded1")>]
type RibbonToggleButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable
Public Interface RibbonToggleButton
Implements IComponent, IDisposable, RibbonControl
属性
実装

注釈

RibbonToggleButton 使用して、項目が選択されているかどうかを表示できます。

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

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

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

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

注意

これは、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

プロパティ

Checked

トグル ボタンが押されているかどうかを示す値を取得または設定します。

ControlSize

RibbonToggleButton コントロールのサイズを取得または設定します。

Description

メニューのこの RibbonToggleButton コントロールに表示されるテキストを取得または設定します。

Enabled

この RibbonControl が有効であるかどうかを示す値を取得または設定します。

(継承元 RibbonControl)
Id

この RibbonControl オブジェクトを識別するために Microsoft Office が使用する文字列を取得します。

(継承元 RibbonControl)
Image

コントロールに表示されるイメージを取得または設定します。

ImageName

コントロールのイメージを指定するために LoadImage イベント ハンドラーで使用できる名前を取得または設定します。

KeyTip

トグル ボタンのキーボード ショートカットを取得または設定します。

Label

トグル ボタンのテキストを取得または設定します。

Name

この RibbonComponent の名前を取得または設定します。

(継承元 RibbonComponent)
OfficeImageId

Microsoft Office の組み込みアイコンを使用する場合に、RibbonToggleButton 上に表示するイメージを取得または設定します。

Parent

この RibbonComponent の親を表す RibbonComponent を取得します。

(継承元 RibbonComponent)
Position

コントロールが Microsoft Office メニュー上にある場合に、RibbonToggleButton の位置を取得または設定します。

Ribbon

コントロール階層を含む最上位 Ribbon オブジェクトを取得します。

(継承元 RibbonComponent)
RibbonUI

Microsoft Office アプリケーションによってリボン機能拡張コードに提供される IRibbonUI のインスタンスを取得します。

(継承元 RibbonComponent)
ScreenTip

ユーザーがポインターをトグル ボタンの上に移動したときに表示されるヒント テキストを取得または設定します。

ShowImage

RibbonToggleButton に関連付けられているイメージが表示されるかどうかを示す値を取得または設定します。

ShowLabel

RibbonToggleButton のラベルが表示されるかどうかを示す値を取得または設定します。

SuperTip

ユーザーがポインターを RibbonToggleButton コントロールの上に移動したときに表示される複数行のヒント テキストを取得または設定します。

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

ユーザーが RibbonToggleButton コントロールをクリックすると発生します。

適用対象