次の方法で共有


RibbonDialogLauncher インターフェイス

ダイアログ ボックスを開くために使用できる、グループ上の小さい標準アイコンを表します。

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

構文

'宣言
<GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")> _
Public Interface RibbonDialogLauncher _
    Inherits IDisposable
[GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")]
public interface RibbonDialogLauncher : IDisposable

RibbonDialogLauncher 型で公開されるメンバーは以下のとおりです。

プロパティ

  名前 説明
パブリック プロパティ Enabled この RibbonDialogLauncher が使用可能になっているかどうかを示す値を取得または設定します。
パブリック プロパティ Image この RibbonDialogLauncher をクイック アクセス ツール バーに追加したときに表示されるイメージを取得または設定します。
パブリック プロパティ ImageName クイック アクセス ツール バーにこの RibbonDialogLauncher を追加するときにイメージを割り当てるために使用される識別子を取得または設定します。
パブリック プロパティ KeyTip この RibbonDialogLauncher のキーボード ショートカットを取得または設定します。
パブリック プロパティ OfficeImageId Microsoft Office の組み込みアイコンを使用する場合に、この RibbonDialogLauncher に表示するイメージを取得または設定します。
パブリック プロパティ Parent この RibbonDialogLauncher がメンバーとして含まれている RibbonGroup オブジェクトを取得します。
パブリック プロパティ Ribbon この RibbonDialogLauncher が配置される OfficeRibbon を取得します。
パブリック プロパティ ScreenTip ユーザーがポインターを RibbonDialogLauncher の上に移動したときに表示されるヒント テキストを取得または設定します。
パブリック プロパティ SuperTip ユーザーがポインターを RibbonDialogLauncher の上に移動したときに表示される複数行のヒント テキストを取得または設定します。
パブリック プロパティ Visible この RibbonDialogLauncher が表示されるかどうかを示す値を取得または設定します。

このページのトップへ

メソッド

  名前 説明
パブリック メソッド Dispose アンマネージ リソースの解放およびリセットに関連付けられているアプリケーション定義のタスクを実行します。 (IDisposable から継承されます。)
パブリック メソッド ResumeLayout SuspendLayout メソッドの実行結果を元に戻します。
パブリック メソッド SuspendLayout Microsoft Office アプリケーションが OfficeRibbon 内のコントロールの状態を更新できないようにします。

このページのトップへ

解説

RibbonDialogLauncher は、既定では、グループの右下隅に表示されます。

RibbonDialogLauncher がリボン上のグループ内に表示されるときは、ImageImageName、および OfficeImageId の各プロパティには目に見える効果はありません。一方、ユーザーが RibbonDialogLauncher をクイック アクセス ツール バーに追加するときは、表示されるイメージの動作をこれらのプロパティが制御します。また、クイック アクセス ツール バーに表示されるときは、Visible プロパティによって RibbonDialogLauncher が非表示になることはありません。ユーザーはリボン (XML) アイテムを使用して、RibbonDialogLauncher をクイック アクセス ツール バーに追加できます。詳細については、「リボンの概要」を参照してください。

RibbonDialogLauncher は、RibbonGroup に対してのみ適用されます。RibbonGroup オブジェクトには、RibbonDialogLauncher 型の DialogLauncher メンバーがあります。RibbonDialogLauncher を RibbonGroup に追加する方法については、「方法 : リボン グループにダイアログ ボックス起動ツールを追加する」を参照してください。

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

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

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

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

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

[!メモ]

これは、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 を参照してください。

次の例では、RibbonDialogLauncher をリボン グループに追加する方法と、ユーザーが RibbonGroup の右下隅にある RibbonDialogLauncher アイコンをクリックしたときにカスタム ダイアログを起動して、詳細設定を選択できるようにする方法を示します。

このコード例を実行するには、最初に次の手順を実行する必要があります。

  1. [リボン (ビジュアル デザイナー)] アイテムを Office プロジェクトに追加します。

  2. 方法 : リボン グループにダイアログ ボックス起動ツールを追加する」で説明されているように、RibbonDialogLauncher を既定のグループ Group1 に追加します。

  3. Visual Basic プロジェクトを使用している場合は、プロジェクトに新しい Dialog アイテムを追加します。C# を使用している場合は、新しい Windows Form アイテムを追加し、フォームに [OK] ボタンと [Cancel] ボタンを追加してボタンのクリック イベントのイベント ハンドラーを作成することでダイアログに変えます。

  4. ダイアログの (Name) プロパティを advancedSettingsDialog に設定します。コントロールを追加したり、プロパティを設定したりして、ダイアログをカスタマイズできます。

  5. コードに DialogLauncherClick イベント ハンドラーを追加します。

  6. DialogLauncherClick イベント ハンドラーに、次のメソッドの内容を設定します。

Private Sub Group1_DialogLauncherClick(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles Group1.DialogLauncherClick
    Dim dlg As advancedSettingsDialog = New advancedSettingsDialog()
    dlg.ShowDialog()
End Sub
void group1_DialogLauncherClick(object sender, Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs e)
{
    advancedSettingsDialog dlg = new advancedSettingsDialog();
    dlg.ShowDialog();
}

参照

関連項目

Microsoft.Office.Tools.Ribbon 名前空間

その他の技術情報

方法: Office プロジェクトでイベント ハンドラーを作成する

リボンの概要

リボン デザイナー

リボン オブジェクト モデルの概要

方法 : リボンのカスタマイズの概要