ToolStripItem.ImageKey Propriedade

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtém ou define o acessador de chave para a imagem na ImageList que é exibido em um 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; }

[<System.ComponentModel.Browsable(false)>]
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageKeyConverter))>]
[<System.Windows.Forms.RelatedImageList("Owner.ImageList")>]
member this.ImageKey : string with get, set

Public Property ImageKey As String

Valor da propriedade

String

Uma cadeia de caracteres que representa a chave da imagem.

Atributos

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

Exemplos

O exemplo de código a seguir demonstra como definir a ImageKey propriedade. Este exemplo de código faz parte de um exemplo maior fornecido para a ToolStripItem classe.

// 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

Comentários

ImageKey e ImageIndex são mutuamente exclusivos, ou seja, se um for definido, o outro será definido como um valor inválido e ignorado. Se você definir a ImageKey propriedade, a ImageIndex propriedade será definida automaticamente como -1. Como alternativa, se você definir a ImageIndex propriedade, ela ImageKey será definida automaticamente como uma cadeia de caracteres vazia ("").

As Imagepropriedades , ImageAligne ImageKeyImageIndexImageScaling propriedades pertencem a vários aspectos do tratamento de imagem. Use imagens em ToolStrip controles definindo essas propriedades diretamente ou definindo a propriedade somente ImageList tempo de execução.

O dimensionamento de imagem é determinado pela interação das propriedades em ambos ToolStrip e ToolStripItem, da seguinte maneira:

• ImageScalingSize é a escala da imagem final, conforme determinado pela combinação da configuração da ImageScaling imagem e da configuração do AutoSize contêiner.

  • Se AutoSize for true (o padrão) e ToolStripItemImageScaling for SizeToFit, nenhum dimensionamento de imagem ocorrerá e o ToolStrip tamanho for o do maior item ou um tamanho mínimo prescrito.

  • Se AutoSize for false e ToolStripItemImageScaling for None, não ocorrerá imagem nem ToolStrip dimensionamento.