RibbonDialogLauncher, interface

Article
01/06/2014

Représente une petite icône standardisée sur un groupe qui peut être utilisée pour ouvrir une boîte de dialogue.

Espace de noms : Microsoft.Office.Tools.Ribbon
Assembly : Microsoft.Office.Tools.Common (dans Microsoft.Office.Tools.Common.dll)

Syntaxe

'Déclaration
<GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")> _
Public Interface RibbonDialogLauncher _
    Inherits IDisposable

[GuidAttribute("e143d5e9-e844-4052-9793-2070185d351d")]
public interface RibbonDialogLauncher : IDisposable

Le type RibbonDialogLauncher expose les membres suivants.

Propriétés

	Nom	Description
	Enabled	Obtient ou définit une valeur qui indique si ce RibbonDialogLauncher est activé.
	Image	Obtient ou définit une image qui apparaît sur ce RibbonDialogLauncher lorsqu'il est ajouté à la barre d'outils Accès rapide.
	ImageName	Obtient ou définit un identificateur utilisé pour assigner une image à ce RibbonDialogLauncher lorsqu'il est ajouté à la barre d'outils Accès rapide.
	KeyTip	Obtient ou définit le raccourci clavier pour ce RibbonDialogLauncher.
	OfficeImageId	Obtient ou définit l'image à afficher sur ce RibbonDialogLauncher, si vous souhaitez utiliser une icône Microsoft Office intégrée.
	Parent	Obtient un objet RibbonGroup dont ce RibbonDialogLauncher est un membre.
	Ribbon	Obtient le OfficeRibbon sur lequel ce RibbonDialogLauncher est placé.
	ScreenTip	Obtient ou définit le texte info-bulle qui apparaît lorsque l'utilisateur déplace le pointeur sur le RibbonDialogLauncher.
	SuperTip	Obtient ou définit le texte info-bulle multiligne qui apparaît lorsque l'utilisateur déplace le pointeur sur le RibbonDialogLauncher.
	Visible	Obtient ou définit une valeur qui indique si ce RibbonDialogLauncher est visible.

Début

Méthodes

	Nom	Description
	Dispose	Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées. (Hérité de IDisposable.)
	ResumeLayout	Inverse l'effet de la méthode SuspendLayout.
	SuspendLayout	Empêche l'application Microsoft Office d'actualiser l'état des contrôles dans le OfficeRibbon.

Début

Notes

Un RibbonDialogLauncher est affiché par défaut dans l'angle inférieur droit d'un groupe.

Les propriétés Image, ImageName et OfficeImageId n'ont aucun effet visible lorsque le RibbonDialogLauncher est affiché dans un groupe sur le ruban. Toutefois, lorsqu'un utilisateur ajoute un RibbonDialogLauncher à la barre d'outils Accès rapide, ces propriétés contrôlent le comportement de l'image affichée. De plus, la propriété Visible ne masque pas le RibbonDialogLauncher lorsqu'il est affiché dans la barre d'outils Accès rapide. L'utilisateur peut ajouter RibbonDialogLauncher à la barre d'outils Accès rapide via l'élément Ruban (XML). Pour plus d'informations, consultez Vue d'ensemble du ruban.

Le RibbonDialogLauncher s'applique uniquement à un RibbonGroup. L'objet RibbonGroup a un membre DialogLauncher du type RibbonDialogLauncher. Pour plus d'informations sur la façon d'ajouter un RibbonDialogLauncher à un RibbonGroup, consultez Comment : ajouter un lanceur de boîte de dialogue à un groupe de ruban.

Vous pouvez créer un RibbonDialogLauncher au moment de l'exécution à l'aide de la méthode CreateRibbonDialogLauncher de l'objet RibbonFactory.

Il existe deux méthodes pour accéder à l'objet RibbonFactory :

En utilisant la propriété Factory de la classe du ruban. Utilisez cette approche depuis le code dans votre classe de ruban.
En utilisant la méthode Globals.Factory.GetRibbonFactory. Utilisez cette approche depuis le code en dehors de votre classe de ruban.

Certaines propriétés de ce contrôle peuvent être définies uniquement avant de charger le ruban dans l'application Office. Pour plus d'informations sur la définition de ces propriétés, consultez Vue d'ensemble du modèle objet de ruban.

Notes

Cette interface est implémentée par Visual Studio Tools pour Office Runtime. Elle n'est pas destinée à être implémentée dans votre code. Pour plus d'informations, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.

Utilisation

Cette documentation décrit la version de ce type utilisée dans les projets Office qui ciblent .NET Framework 4 et .NET Framework 4.5. Dans les projets qui ciblent .NET Framework 3.5, ce type peut contenir d'autres membres, et les exemples de code qui y figurent sont susceptibles de ne pas fonctionner. Pour obtenir de la documentation sur ce type dans les projets ciblant .NET Framework 3.5, consultez la section de référence suivante dans la documentation Visual Studio 2008 : https://go.microsoft.com/fwlink/?LinkId=160658.

Exemples

L'exemple suivant indique comment ajouter un RibbonDialogLauncher à un groupe de ruban et comment lancer une boîte de dialogue personnalisée qui permet aux utilisateurs de choisir des paramètres avancés lorsqu'ils cliquent sur l'icône RibbonDialogLauncher dans l'angle inférieur droit de RibbonGroup.

Pour exécuter cet exemple de code, vous devez exécuter tout d'abord les étapes suivantes :

Ajoutez un élément Ruban (Concepteur visuel) à un projet Office.
Ajoutez un RibbonDialogLauncher au groupe par défaut Group1 comme décrit dans Comment : ajouter un lanceur de boîte de dialogue à un groupe de ruban.
Si vous utilisez Visual Basic, ajoutez un nouvel élément Boîte de dialogue au projet. Si vous utilisez C#, ajoutez un nouvel élément Windows Form et transformez-le en boîte de dialogue en ajoutant des boutons OK et Annuler au formulaire et en créant des gestionnaires d'événements pour les événements Click des boutons.
Définissez la propriété (Name) de la boîte de dialogue advancedSettingsDialog. Vous pouvez personnaliser la boîte de dialogue en ajoutant des contrôles et en définissant davantage de propriétés.
Ajoutez le gestionnaire d'événements DialogLauncherClick à votre code.
Placez le contenu de la méthode suivante dans le gestionnaire d'événements 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();
}