Proprietà RibbonToggleButton.ImageName

Articolo
08/11/2011

Ottiene o imposta il nome utilizzabile nel gestore eventi LoadImage per identificare un'immagine per il controllo.

Spazio dei nomi: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Sintassi

'Dichiarazione
Property ImageName As String
    Get
    Set

string ImageName { get; set; }

Valore proprietà

Tipo: System.String
Stringa utilizzabile nel gestore eventi LoadImage per identificare un'immagine per il controllo.

Note

La proprietà ImageName identifica un'immagine visualizzata dal controllo. Nell'applicazione di Office, l'immagine viene recuperata dalla soluzione soltanto una volta per migliorare le prestazioni. Questa proprietà può essere impostata solo in fase di progettazione, perché l'immagine che identifica viene caricata durante l'evento LoadImage. LoadImage viene generato solo una volta per nome dell'immagine, quando viene visualizzata la Barra multifunzione. Successivamente non sarà possibile modificare l'immagine del controllo mediante questa proprietà.

Per caricare l'immagine, aggiungere codice al gestore eventi LoadImage. Selezionare la proprietà ImageName di RibbonLoadImageEventArgs e impostare la proprietà Image dell'oggetto RibbonLoadImageEventArgs sull'immagine da caricare.

Se la proprietà Image o OfficeImageId è impostata, tale proprietà viene ignorata. Le immagini identificate dalla proprietà ImageName presentano una velocità di caricamento leggermente superiore rispetto alle immagini identificate dalla proprietà Image, poiché nell'applicazione di Office l'immagine viene recuperata dalla soluzione soltanto la prima volta che la barra multifunzione viene visualizzata.

Perché il controllo sia in grado di visualizzare l'immagine, il valore della proprietà ShowImage deve essere true. Quando si imposta la proprietà ImageName in fase di progettazione, Visual Studio imposta automaticamente la proprietà ShowImage su true. Se la proprietà ImageName viene impostata in fase di esecuzione, la proprietà ShowImage va impostata su true nel codice.

Esempi

Nell'esempio riportato di seguito viene illustrato come memorizzare nella cache le immagini di due pulsanti.

Per eseguire questo esempio di codice, effettuare innanzitutto le seguenti operazioni:

Aggiungere un elemento Barra multifunzione (finestra di progettazione visiva) a un progetto Office.
Aggiungere un gruppo alla scheda personalizzata.
Aggiungere due pulsanti al gruppo.
Aggiungere due immagini alle risorse del progetto. Per ulteriori informazioni, vedere Procedura: aggiungere o rimuovere risorse.

Sarà quindi possibile eseguire il codice nella classe Ribbon generata.

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

Sicurezza di .NET Framework

Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.