RibbonGroup.DialogLauncher Property

Definition

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Gets or sets the Ribbon dialog launcher that is associated with the group.

public:
 property Microsoft::Office::Tools::Ribbon::RibbonDialogLauncher ^ DialogLauncher { Microsoft::Office::Tools::Ribbon::RibbonDialogLauncher ^ get(); void set(Microsoft::Office::Tools::Ribbon::RibbonDialogLauncher ^ value); };

public Microsoft.Office.Tools.Ribbon.RibbonDialogLauncher DialogLauncher { get; set; }

member this.DialogLauncher : Microsoft.Office.Tools.Ribbon.RibbonDialogLauncher with get, set

Public Property DialogLauncher As RibbonDialogLauncher

Property Value

RibbonDialogLauncher

The Ribbon dialog launcher that is associated with the group.

Examples

The following example shows how to set the KeyTip and ScreenTip properties on the RibbonDialogLauncher that is added to the default group.

To run this code example, you must first perform the following steps:

1. Add a Ribbon (Visual Designer) item to an Office project.

2. Add a RibbonDialogLauncher to the default group Group1 as outlined in How to: Add a Dialog Box Launcher to a Ribbon Group.

private void SetDialogLauncherProperties()
{
    group1.DialogLauncher.KeyTip = "A";
    group1.DialogLauncher.ScreenTip = "Advanced Settings";
}

Private Sub SetDialogLauncherProperties()
    Group1.DialogLauncher.KeyTip = "A"
    Group1.DialogLauncher.ScreenTip = "Advanced Settings"
End Sub

Remarks

The Ribbon dialog launcher is a small icon that appears in the group. When the user clicks this icon, you can handle the DialogLauncherClick event to open a custom dialog box. By default, groups do not have a Ribbon dialog launcher. For more information, see How to: Add a Dialog Box Launcher to a Ribbon Group.

You can customize the behavior of the Ribbon dialog launcher by using properties of the RibbonDialogLauncher interface. For example, to set the screen tip that appears when the user moves the pointer over the dialog launcher icon, use the ScreenTip property.

Some properties of the RibbonDialogLauncher interface, such as the Image property, are only applicable when the end user adds it to the Quick Access Toolbar.