RibbonToggleButton.ImageName (Propiedad)

Artículo
05/15/2013

Obtiene o establece el nombre que se puede usar en el controlador de eventos LoadImage para identificar una imagen del control.

Espacio de nombres: Microsoft.Office.Tools.Ribbon
Ensamblado: Microsoft.Office.Tools.Common (en Microsoft.Office.Tools.Common.dll)

Sintaxis

'Declaración
Property ImageName As String

string ImageName { get; set; }

Valor de propiedad

Tipo: System.String
Cadena que se puede usar en el controlador de eventos LoadImage para identificar una imagen del control.

Comentarios

La propiedad ImageName identifica una imagen mostrada por el control.La aplicación de Office recupera esta imagen de la solución sólo una vez para mejorar el rendimiento.Se puede establecer esta propiedad sólo en tiempo de diseño, porque la imagen que identifica se carga durante el evento LoadImage.LoadImage sólo se eleva una vez por el nombre de imagen, cuando se muestra la Cinta.Después, no se puede cambiar la imagen del control mediante esta propiedad.

Para cargar la imagen, agregue código al controlador de eventos LoadImage.Compruebe la propiedad ImageName de RibbonLoadImageEventArgs y establezca la propiedad Image del objeto RibbonLoadImageEventArgs en la imagen que desee cargar.

Esta propiedad se omite si se ha establecido la propiedad Image u OfficeImageId.Las imágenes identificadas por la propiedad ImageName se pueden cargar un poco más rápido que las imágenes identificadas por la propiedad Image porque la aplicación de Office recupera la imagen de la solución sólo la primera vez que se muestra la cinta de opciones.

La propiedad ShowImage debe ser true para que el control muestre la imagen.Cuando se establece la propiedad ImageName en tiempo de diseño, Visual Studio automáticamente establece la propiedad ShowImage en true.Si establece la propiedad ImageName en tiempo de ejecución, debe establecer en el código la propiedad ShowImage en true.

Ejemplos

En el ejemplo siguiente se almacenan en memoria caché las imágenes de dos botones.

Para poder ejecutar este ejemplo de código, primero debe seguir este procedimiento:

Agregue un elemento Cinta (diseñador visual) a un proyecto de Office.
Agregue un grupo a la ficha personalizada.
Agregue dos botones al grupo.
Agregue dos imágenes a los recursos del proyecto.Para obtener más información, vea Cómo: Agregar o quitar recursos.

A continuación, podrá ejecutar este código en la clase Ribbon generada.

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

Seguridad de .NET Framework

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.