ToolStripItem.ImageIndex Propriedade

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtém ou define o valor do índice da imagem que é exibido no item.

public:
 property int ImageIndex { int get(); void set(int value); };

[System.ComponentModel.Browsable(false)]
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.NoneExcludedImageIndexConverter))]
[System.Windows.Forms.RelatedImageList("Owner.ImageList")]
public int ImageIndex { get; set; }

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

Public Property ImageIndex As Integer

Valor da propriedade

Int32

O índice baseado em zero da imagem no ImageList que é exibido para o item. O padrão é -1, significando que a lista de imagens está vazia.

Atributos

BrowsableAttribute TypeConverterAttribute RelatedImageListAttribute

Exceções

ArgumentOutOfRangeException

value é menor que -1.

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.

Se o valor da ImageList propriedade for alterado para null, a ImageIndex propriedade retornará seu valor padrão, -1. No entanto, o valor atribuído ImageIndex é retido internamente e usado quando outro ImageList objeto é atribuído à ImageList propriedade. Se o novo ImageList atribuído à ImageList propriedade tiver um ImageList.ImageCollection.Count valor de propriedade menor ou igual ao valor atribuído à ImageIndex propriedade menos um (para considerar a coleção sendo um índice baseado em zero), o valor da ImageIndex propriedade será ajustado para um menor que o valor da Count propriedade. Por exemplo, considere um controle de botão cujos ImageList três imagens e cuja ImageIndex propriedade está definida como 2. Se uma nova ImageList que tem apenas duas imagens for atribuída ao botão, o ImageIndex valor será alterado para 1.