ToolStripItem.ImageKey ToolStripItem.ImageKey ToolStripItem.ImageKey ToolStripItem.ImageKey Property

Definición

Obtiene o establece el descriptor de acceso clave para la imagen en el ImageList que se muestra en un ToolStripItem.Gets or sets the key accessor for the image in the ImageList that is displayed on a ToolStripItem.

public:
 property System::String ^ ImageKey { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Browsable(false)]
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageKeyConverter))]
[System.Windows.Forms.RelatedImageList("Owner.ImageList")]
public string ImageKey { get; set; }
member this.ImageKey : string with get, set
Public Property ImageKey As String

Valor de propiedad

Cadena que representa la clave de la imagen.A string representing the key of the image.

Ejemplos

En el ejemplo de código siguiente se muestra cómo establecer el ImageKey propiedad.The following code example demonstrates how to set the ImageKey property. Este ejemplo de código forma parte de un ejemplo más extenso proporcionado para el ToolStripItem clase.This code example is part of a larger example provided for the ToolStripItem class.

// 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;
}
' This utility method creates a RolloverItem 
' and adds it to a ToolStrip control.
 Private Function CreateRolloverItem( _
 ByVal owningToolStrip As ToolStrip, _
 ByVal txt As String, _
 ByVal f As Font, _
 ByVal imgKey As String, _
 ByVal tir As TextImageRelation, _
 ByVal backImgKey As String) As RolloverItem

     Dim item As 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
 End Function

Comentarios

El ImageIndex propiedad especifica la posición de la imagen en la lista de imágenes.The ImageIndex property specifies the position of the image in the image list. El ImageKey propiedad especifica la imagen en Sí.The ImageKey property specifies the image itself.

El Image, ImageAlign, ImageIndex, ImageKey, y ImageScaling propiedades corresponden a varios aspectos del control de imagen.The Image, ImageAlign, ImageIndex, ImageKey, and ImageScaling properties pertain to various aspects of image handling. Usar imágenes en ToolStrip controles al establecer estas propiedades directamente o mediante el establecimiento de la ejecución solo de tiempo ImageList propiedad.Use images in ToolStrip controls by setting these properties directly or by setting the run-time-only ImageList property.

Escalado de imagen viene determinada por la interacción de las propiedades de ambos ToolStrip y ToolStripItem, como sigue:Image scaling is determined by the interaction of properties in both ToolStrip and ToolStripItem, as follows:

Se aplica a