Share via

RibbonGroup.DialogLauncher Property (2007 System)

  • Article

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

Namespace:  Microsoft.Office.Tools.Ribbon
Assembly:  Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)

Syntax

'Declaration
Public Property DialogLauncher As RibbonDialogLauncher

'Usage
Dim instance As RibbonGroup 
Dim value As RibbonDialogLauncher 

value = instance.DialogLauncher

instance.DialogLauncher = value

public RibbonDialogLauncher DialogLauncher { get; set; }

public:
property RibbonDialogLauncher^ DialogLauncher {
    RibbonDialogLauncher^ get ();
    void set (RibbonDialogLauncher^ value);
}

public function get DialogLauncher () : RibbonDialogLauncher 
public function set DialogLauncher (value : RibbonDialogLauncher)

Property Value

Type: Microsoft.Office.Tools.Ribbon.RibbonDialogLauncher
The Ribbon dialog launcher that is associated with the group.

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 class. 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 class, such as the Image property, are only applicable when the end user adds it to the Quick Access Toolbar.

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 a Visual Studio Tools for 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 Sub SetDialogLauncherProperties()
    Group1.DialogLauncher.KeyTip = "A"
    Group1.DialogLauncher.ScreenTip = "Advanced Settings"         
End Sub

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

.NET Framework Security

See Also

Reference

RibbonGroup Class

RibbonGroup Members

Microsoft.Office.Tools.Ribbon Namespace

Other Resources

How to: Add a Dialog Box Launcher to a Ribbon Group