RibbonToggleButton.OfficeImageId, propriété

Article
01/06/2014

Obtient ou définit l'image à afficher sur le RibbonToggleButton, si vous souhaitez utiliser une icône Microsoft Office intégrée.

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

Syntaxe

'Déclaration
Property OfficeImageId As String

string OfficeImageId { get; set; }

Valeur de propriété

Type : System.String
ID d'une icône Microsoft Office intégrée qui sert d'icône pour ce contrôle.

Notes

La propriété OfficeImageId identifie une icône Office affichée par le contrôle. La valeur de la propriété est une chaîne qui identifie la valeur imageMso de l'icône sélectionnée. Cette propriété peut être définie au moment du design ou de l'exécution. Si vous mettez à jour cette propriété au moment de l'exécution, l'apparence du contrôle est mise à jour pour refléter la modification.

Pour une liste des valeurs de imageMso, consultez la page du Centre de téléchargement Microsoft Complément 2010 Office System : Galerie d'icônes.

Cette propriété est ignorée si la propriété Image est définie. Les images identifiées par la propriété OfficeImageId peuvent être chargées légèrement plus rapidement que les images identifiées par la propriété Image car les images sont mises en cache dans l'application Office.

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

Exemples

L'exemple suivant attribue une icône Microsoft Office à un menu.

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 un bouton bascule au groupe.

Private Sub SetToggleButtonImage()
    ToggleButton1.OfficeImageId = "PersonaStatusOnline"
    ToggleButton1.ShowImage = True
End Sub

private void SetToggleButtonImage()
{
    toggleButton1.OfficeImageId = "PersonaStatusOnline";
    toggleButton1.ShowImage = true;
}

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.