RibbonDialogLauncher, classe (System 2007)

Mise à jour : novembre 2007

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.v9.0 (dans Microsoft.Office.Tools.Common.v9.0.dll)

Syntaxe

Public NotInheritable Class RibbonDialogLauncher _
    Implements IDisposable

Dim instance As RibbonDialogLauncher

public sealed class RibbonDialogLauncher : IDisposable

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. La classe 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.

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.

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 Visual Studio Tools pour 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.
Attribuez la valeur advancedSettingsDialog à la propriété (Name) de la boîte de dialogue. 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();
}

Hiérarchie d'héritage

System.Object
Microsoft.Office.Tools.Ribbon.RibbonDialogLauncher

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.