ButtonBase.ImageIndex Propriedade
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Obtém ou define o valor de índice da lista de imagens da imagem exibida no controle de botão.
public:
property int ImageIndex { int get(); void set(int value); };
[System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageIndexConverter))]
public int ImageIndex { get; set; }
[<System.ComponentModel.TypeConverter(typeof(System.Windows.Forms.ImageIndexConverter))>]
member this.ImageIndex : int with get, set
Public Property ImageIndex As Integer
Valor da propriedade
Um índice baseado em zero, que representa a posição da imagem em um ImageList. O padrão é -1.
- Atributos
Exceções
value
é menor que -1.
Exemplos
O exemplo de código a seguir usa a classe Button derivada e define as propriedades e ImageIndex as ImageList propriedades. Esse código requer que um ImageList tenha sido criado e um mínimo de um Image tenha sido atribuído a ele. Esse código também exige que você tenha uma imagem de bitmap nomeada MyBitMap.bmp
armazenada no C:\Graphics
diretório.
private:
void AddMyImage()
{
// Assign an image to the imageList.
imageList1->Images->Add( Image::FromFile( "C:\\Graphics\\MyBitmap.bmp" ) );
// Assign the imageList to the button control.
button1->ImageList = imageList1;
// Select the image from the ImageList (using the ImageIndex property).
button1->ImageIndex = 0;
}
private void AddMyImage()
{
// Assign an image to the ImageList.
ImageList1.Images.Add(Image.FromFile("C:\\Graphics\\MyBitmap.bmp"));
// Assign the ImageList to the button control.
button1.ImageList = ImageList1;
// Select the image from the ImageList (using the ImageIndex property).
button1.ImageIndex = 0;
}
Private Sub AddMyImage()
' Assign an image to the ImageList.
ImageList1.Images.Add(Image.FromFile("C:\Graphics\MyBitmap.bmp"))
' Assign the ImageList to the button control.
button1.ImageList = ImageList1
' Select the image from the ImageList (using the ImageIndex property).
button1.ImageIndex = 0
End Sub
Comentários
Quando as propriedades ou propriedades ImageIndex são definidas, a Image propriedade é definida como seu valor padrão, null
.ImageList
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 ("").
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.