RibbonToggleButton.ImageName, propriété

Article
05/16/2013

Obtient ou définit le nom que vous pouvez utiliser dans le gestionnaire d'événements LoadImage pour identifier une image pour le contrôle.

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

Syntaxe

'Déclaration
Property ImageName As String

string ImageName { get; set; }

Valeur de propriété

Type : System.String
Chaîne que vous pouvez utiliser dans le gestionnaire d'événements LoadImage pour identifier une image pour le contrôle.

Notes

La propriété ImageName identifie une image affichée par le contrôle.L'application Office extrait cette image de votre solution une seule fois pour améliorer les performances.Cette propriété peut être définie uniquement au moment du design, parce que l'image qu'elle identifie est chargée pendant l'événement LoadImage.LoadImage est déclenché une seule fois par nom d'image, lorsque le Ruban est affiché.Après cela, l'image du contrôle ne peut pas être modifiée en utilisant cette propriété.

Pour charger l'image, ajoutez le code au gestionnaire d'événements LoadImage.Vérifiez la propriété ImageName du RibbonLoadImageEventArgs et affectez à la propriété Image de l'objet RibbonLoadImageEventArgs l'image que vous voulez charger.

Cette propriété est ignorée si la propriété Image ou la propriété OfficeImageId est définie.Les images identifiées par la propriété ImageName peuvent être chargées légèrement plus rapidement que les images identifiées par la propriété Image étant donné que l'application Office extrait l'image de votre solution uniquement la première fois que le ruban est affiché.

Pour que le contrôle affiche l'image, la propriété ShowImage doit avoir la valeur true.Lorsque vous définissez la propriété ImageName au moment du design, Visual Studio définit automatiquement la propriété ShowImage à true.Si vous définissez la propriété ImageName au moment de l'exécution, vous devez affecter à la propriété ShowImage la valeur true dans votre code.

Exemples

L'exemple suivant met en cache les images pour les deux boutons.

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 groupe à un onglet personnalisé.
Ajoutez deux boutons au groupe.
Ajoutez deux images aux ressources du projet.Pour plus d'informations, consultez Comment : ajouter ou supprimer des ressources.

Vous pouvez exécuter ensuite ce code dans la classe du ruban générée.

Private Sub Ribbon1_LoadImage(ByVal sender As Object, _
    ByVal e As RibbonLoadImageEventArgs)
    Select Case e.ImageName
        Case "Button1Image"
            e.Image = My.Resources.Image1
        Case "Button2Image"
            e.Image = My.Resources.Image2
    End Select
End Sub

private void Ribbon1_LoadImage(object sender, RibbonLoadImageEventArgs e)
{
    switch (e.ImageName)
    {
        case "Button1Image":
            e.Image = Properties.Resources.Image1;
            break;
        case "Button2Image":
            e.Image = Properties.Resources.Image2;
            break;
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.