RibbonToggleButton.ImageName-Eigenschaft

Artikel
08/10/2011

Ruft den Namen ab oder legt den Namen fest, den Sie im LoadImage-Ereignishandler zum Identifizieren eines Bilds für das Steuerelement verwenden können.

Namespace: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Syntax

'Declaration
Property ImageName As String
    Get
    Set

string ImageName { get; set; }

Eigenschaftswert

Typ: System.String
Eine Zeichenfolge, die im LoadImage-Ereignishandler zum Identifizieren eines Bilds für das Steuerelement verwendet werden kann.

Hinweise

Mit der ImageName-Eigenschaft wird ein vom Steuerelement angezeigtes Bild identifiziert. Die Office-Anwendung ruft dieses Bild zur Leistungssteigerung nur einmal von der Projektmappe ab. Diese Eigenschaft kann nur zur Entwurfszeit festgelegt werden, da das Bild, das sie identifiziert, während des LoadImage-Ereignisses geladen wird. LoadImage wird nur einmal pro Bildname ausgelöst, wenn das Menüband angezeigt wird. Anschließend kann das Steuerelementbild mithilfe dieser Eigenschaft nicht geändert werden.

Fügen Sie zum Laden des Bilds dem LoadImage-Ereignishandler Code hinzu. Überprüfen Sie die ImageName-Eigenschaft von RibbonLoadImageEventArgs, und legen Sie die Image-Eigenschaft des RibbonLoadImageEventArgs-Objekts auf das zu ladende Bild fest.

Diese Eigenschaft wird bei Festlegen der Image-Eigenschaft bzw. der OfficeImageId-Eigenschaft ignoriert. Durch die ImageNameEigenschaft identifizierte Bilder können ein wenig schneller als Bilder geladen werden, die durch die Image-Eigenschaft identifiziert werden, da die Office-Anwendung das Bild nur beim ersten Anzeigen des Menübands von der Projektmappe abruft.

Die ShowImage-Eigenschaft muss true sein, damit das Bild vom Steuerelement angezeigt wird. Wenn Sie die ImageName-Eigenschaft zur Entwurfszeit festlegen, legt Visual Studio die ShowImage-Eigenschaft automatisch auf true fest. Wird die ImageName-Eigenschaft während der Laufzeit festgelegt, muss die ShowImage-Eigenschaft im Code auf true festgelegt werden.

Beispiele

Im folgenden Beispiel werden die Bilder für zwei Schaltflächen zwischengespeichert.

Zum Ausführen dieses Codebeispiels müssen zuerst die folgenden Schritte ausgeführt werden:

Fügen Sie einem Office-Projekt ein Menüband (Visual Designer)-Element hinzu.
Fügen Sie der benutzerdefinierten Registerkarte eine Gruppe hinzu.
Fügen Sie der Gruppe zwei Schaltflächen hinzu.
Fügen Sie den Projektressourcen zwei Bilder hinzu. Weitere Informationen finden Sie unter Gewusst wie: Hinzufügen oder Entfernen von Ressourcen.

Anschließend kann dieser Code in der generierten Menübandklasse ausgeführt werden.

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;
    }
}

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.