RibbonDialogLauncher Class (2007 System)
Represents a small standardized icon on a group that can be used to open a dialog box.
Assembly: Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)
A is displayed in the lower-right corner of a group by default.
The Image, ImageName, and OfficeImageId properties have no visible effect when the is displayed in a group on the Ribbon. However, when a user adds a to the Quick Access Toolbar, these properties control the behavior of the image that is shown. Also, the Visible property does not hide the when it is displayed on the Quick Access Toolbar. The user can add the to the Quick Access Toolbar through the Ribbon (XML) item. For more information, see Ribbon Overview.
The applies only to a RibbonGroup. The RibbonGroup class has a DialogLauncher member of the type. For information about how to add a to a RibbonGroup, see How to: Add a Dialog Box Launcher to a Ribbon Group.
Some properties of this control can be set only before the Ribbon is loaded into the Office application. For information about setting these properties, see Ribbon Object Model Overview.
The following example shows how to add a to a Ribbon group and how to launch a custom dialog that enables users to choose advanced settings when they click on the icon in the lower right corner of the RibbonGroup.
To run this code example, you must first perform the following steps:
Add a Ribbon (Visual Designer) item to a Visual Studio Tools for Office project.
Add a to the default group Group1 as outlined in How to: Add a Dialog Box Launcher to a Ribbon Group.
If you are using Visual Basic, add a new Dialog item to the project. If you are using C#, add a new Windows Form item and turn it into a dialog by adding OK and Cancel buttons to the form and by creating event handlers for the buttons' click events.
Set the (Name) property of the dialog to advancedSettingsDialog. You can customize the dialog by adding controls and setting more properties.
Add the DialogLauncherClick event handler to your code.
Place the contents of the following method into the DialogLauncherClick event handler.