RibbonToggleButton インターフェイス
リボンのトグル ボタン コントロールを表します。
名前空間: Microsoft.Office.Tools.Ribbon
アセンブリ: Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll 内)
構文
'宣言
<GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")> _
Public Interface RibbonToggleButton _
Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("fc50977f-187c-4082-ab53-087e81f4ded1")]
public interface RibbonToggleButton : RibbonControl,
RibbonComponent, IComponent, IDisposable
RibbonToggleButton 型で公開されるメンバーは以下のとおりです。
プロパティ
名前 | 説明 | |
---|---|---|
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 のラベルが表示されるかどうかを示す値を取得または設定します。 | |
Site | IComponent に関連付けられた ISite を取得または設定します。 (IComponent から継承されます。) | |
SuperTip | ユーザーがポインターを RibbonToggleButton コントロールの上に移動したときに表示される複数行のヒント テキストを取得または設定します。 | |
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 | ユーザーが RibbonToggleButton コントロールをクリックすると発生します。 | |
Disposed | コンポーネントの Disposed イベントを処理するメソッドを表します。 (IComponent から継承されます。) |
このページのトップへ
解説
RibbonToggleButton を使用すると、アイテムが選択されているかどうかを表示できます。
RibbonToggleButton は、RibbonFactory オブジェクトの CreateRibbonToggleButton メソッドを使用して実行時に作成できます。
RibbonFactory オブジェクトにアクセスするには、次の 2 つの方法があります。
リボン クラスの Factory プロパティの使用。 この方法は、リボン クラス内のコードから使用します。
Globals.Factory.GetRibbonFactory メソッドの使用。 この方法は、リボン クラス外のコードから使用します。
注意
これは、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 を参照してください。
参照
参照
Microsoft.Office.Tools.Ribbon 名前空間