OfficeRibbon インターフェイス
Visual Studi の Office プロジェクトでリボン デザイナーを使用して作成された Microsoft Office リボンのカスタマイズを表します。
名前空間: Microsoft.Office.Tools.Ribbon
アセンブリ: Microsoft.Office.Tools.Common.v4.0.Utilities (Microsoft.Office.Tools.Common.v4.0.Utilities.dll 内)
Microsoft.Office.Tools.Common (Microsoft.Office.Tools.Common.dll 内)
構文
'宣言
<GuidAttribute("49fbf223-6d24-4c4b-9101-2d5833434328")> _
Public Interface OfficeRibbon _
Inherits RibbonComponent, IComponent, IDisposable
[GuidAttribute("49fbf223-6d24-4c4b-9101-2d5833434328")]
public interface OfficeRibbon : RibbonComponent,
IComponent, IDisposable
OfficeRibbon 型で公開されるメンバーは以下のとおりです。
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
Context | このリボンに関連付けられているインスペクター ウィンドウ (または Outlook のエクスプローラー ウィンドウ) を取得します。 |
|
DefaultExtension | この OfficeRibbon オブジェクトの既定の拡張機能を取得します。 |
|
Extension | この OfficeRibbon オブジェクトのカスタムの拡張機能を取得します。 |
|
Global | この OfficeRibbon を複数のコンテキストで同時に使用できるかどうかを決定する値を取得または設定します。 |
|
Name | この RibbonComponent の名前を取得または設定します。 (RibbonComponent から継承されます。) |
|
OfficeMenu | Microsoft Office メニューのカスタマイズを表す RibbonOfficeMenu を取得します。 |
|
Parent | この RibbonComponent の親を表す RibbonComponent を取得します。 (RibbonComponent から継承されます。) |
|
Ribbon | コントロール階層を含む最上位の Ribbon オブジェクトを取得します。 (RibbonComponent から継承されます。) |
|
RibbonId | OfficeRibbon オブジェクトのこのインスタンスを作成するために使用されたリボン ID を取得します。 |
|
RibbonType | この OfficeRibbon インスタンスに関連付けられているリボン ID の、コンマ区切りのリストを取得します。 |
|
RibbonUI | インフラストラクチャ。Microsoft Office アプリケーションによってリボン機能拡張コードに提供される IRibbonUI のインスタンスを取得します。 (RibbonComponent から継承されます。) |
|
Site | IComponent に関連付けられた ISite を取得または設定します。 (IComponent から継承されます。) |
|
StartFromScratch | リボン上のすべての組み込みタブ、および Microsoft Office メニュー上のほとんどのコマンドを非表示にし、このリボン アイテムで定義されているカスタマイズのみ表示するかどうかを示す値を取得または設定します。 |
|
Tabs | RibbonOfficeMenu 内の RibbonTab オブジェクトのコレクションを取得します。 |
|
Tag | この RibbonComponent と関連付けられたアプリケーション固有のデータを取得または設定します。 (RibbonComponent から継承されます。) |
このページのトップへ
メソッド
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
_VtblGap1_2 | |
|
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 から継承されます。) |
このページのトップへ
イベント
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック イベント") |
Close | この OfficeRibbon インスタンスが閉じられたときに発生します。 |
|
Disposed | コンポーネントの Disposed イベントを処理するメソッドを表します。 (IComponent から継承されます。) |
|
Load | OfficeRibbon が Microsoft Office アプリケーションに読み込まれるときに発生します。 |
|
LoadImage | ImageName プロパティが 1 つ以上のコントロールに対して設定されている場合に、OfficeRibbon が読み込まれるときに発生します。 |
このページのトップへ
解説
通常、OfficeRibbon インターフェイスは直接使用しません。代わりに、プロジェクトに新しいリボン (ビジュアル デザイナー) アイテムを追加したときに、Visual Studio によって生成されるリボン クラスを使用します。生成されたリボン クラスのイベントおよびプロパティを使用することで、リボンに関連するほとんどのタスクを実行できます。
生成される Ribbon クラスは、RibbonBase クラスから継承します。この基本クラスでは、メンバーへのすべての呼び出しは Visual Studio Tools for Office Runtime の OfficeRibbon インターフェイスの内部実装にリダイレクトされます。OfficeRibbon オブジェクトを直接操作するには、生成されたリボン クラスの Base プロパティを使用します。
[!メモ]
これは、Visual Studio Tools for Office Runtime によって実装されたインターフェイスです。コードに実装されるものではありません。詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。
使用方法
ここでは、.NET Framework 4 および .NET Framework 4.5 を対象とする Office プロジェクトで使用される型のバージョンについて説明します。.NET Framework 3.5 を対象とするプロジェクトでは、この型のメンバーが異なること、およびこのコード例が動作しないことがあります。.NET Framework 3.5 を対象とするプロジェクトの型の詳細については、Visual Studio 2008 ドキュメントの参照セクション https://go.microsoft.com/fwlink/?LinkId=160658 を参照してください。