ToolStripItem.ImageKey Propiedad

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Source:

ToolStripItem.cs

Obtiene o establece el descriptor de acceso clave para la imagen en ImageList que se muestra en un ToolStripItem asociado.

C#

[System.ComponentModel.Browsable(false)]
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageKeyConverter))]
[System.Windows.Forms.RelatedImageList("Owner.ImageList")]
public string ImageKey { get; set; }

Valor de propiedad

String

Cadena que representa la clave de la imagen.

Atributos

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

Ejemplos

En el ejemplo de código siguiente se muestra cómo establecer la ImageKey propiedad . Este ejemplo de código es parte de un ejemplo mayor proporcionado para la clase ToolStripItem.

C#

// This utility method creates a RolloverItem 
// and adds it to a ToolStrip control.
private RolloverItem CreateRolloverItem(
    ToolStrip owningToolStrip,
    string txt,
    Font f,
    string imgKey,
    TextImageRelation tir,
    string backImgKey)
{
    RolloverItem item = new RolloverItem();

    item.Alignment = ToolStripItemAlignment.Left;
    item.AllowDrop = false;
    item.AutoSize = true;

    item.BackgroundImage = owningToolStrip.ImageList.Images[backImgKey];
    item.BackgroundImageLayout = ImageLayout.Center;
    item.DisplayStyle = ToolStripItemDisplayStyle.ImageAndText;
    item.DoubleClickEnabled = true;
    item.Enabled = true;
    item.Font = f;

    // These assignments are equivalent. Each assigns an
    // image from the owning toolstrip's image list.
    item.ImageKey = imgKey;
    //item.Image = owningToolStrip.ImageList.Images[infoIconKey];
    //item.ImageIndex = owningToolStrip.ImageList.Images.IndexOfKey(infoIconKey);
    item.ImageScaling = ToolStripItemImageScaling.None;

    item.Owner = owningToolStrip;
    item.Padding = new Padding(2);
    item.Text = txt;
    item.TextAlign = ContentAlignment.MiddleLeft;
    item.TextDirection = ToolStripTextDirection.Horizontal;
    item.TextImageRelation = tir;

    return item;
}

Comentarios

ImageKey y ImageIndex son mutuamente excluyentes, lo que significa que, si se establece uno, el otro se establece en un valor no válido y se omite. Si establece la ImageKey propiedad , la ImageIndex propiedad se establece automáticamente en -1. Como alternativa, si establece la ImageIndex propiedad , se ImageKey establece automáticamente en una cadena vacía ("").

Las propiedades Image, ImageAlign, ImageIndex, ImageKey y ImageScaling tienen que ver con diversos aspectos del control de imágenes. Use imágenes en ToolStrip controles estableciendo estas propiedades directamente o estableciendo la propiedad solo ImageList en tiempo de ejecución.

El escalado de imágenes viene determinado por la interacción de las propiedades tanto en ToolStrip como en ToolStripItem, como se indica a continuación:

• ImageScalingSize es la escala de la imagen final según viene determinada por la combinación de la configuración de ImageScaling la imagen y la configuración de AutoSize del contenedor.

  • Si AutoSize es true (valor predeterminado) y ToolStripItemImageScaling es SizeToFit, no se produce ningún escalado de imagen y el tamaño de ToolStrip es el del elemento más grande, o bien un tamaño mínimo prescrito.

  • Si AutoSize es false y ToolStripItemImageScaling son None, no se produce ningún escalado de imagen ni de ToolStrip.

Se aplica a