RibbonDialogLauncher クラス (2007 System)

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

更新 : 2007 年 11 月

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

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

構文

'宣言
Public NotInheritable Class RibbonDialogLauncher _
    Implements IDisposable
'使用
Dim instance As RibbonDialogLauncher

public sealed class RibbonDialogLauncher : IDisposable

解説

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

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

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

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

例

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

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

リボン (ビジュアルデザイナ) アイテムを Visual Studio Tools for Office プロジェクトに追加します。
「方法 : リボングループにダイアログボックス起動ツールを追加する」で説明されているように、RibbonDialogLauncher を既定のグループ Group1 に追加します。
Visual Basic プロジェクトを使用している場合は、プロジェクトに新しい Dialog アイテムを追加します。C# を使用している場合は、新しい Windows Form アイテムを追加し、フォームに [OK] ボタンと [Cancel] ボタンを追加してボタンのクリックイベントのイベントハンドラを作成することでダイアログに変えます。
ダイアログの (Name) プロパティを advancedSettingsDialog に設定します。コントロールを追加したり、プロパティを設定したりして、ダイアログをカスタマイズできます。
コードに DialogLauncherClick イベントハンドラを追加します。
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();
}