Label.ImageIndex Propriété

Définition

Obtient ou définit la valeur d'index de l'image affichée sur Label.

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

Valeur de propriété

Un index de base zéro représentant l'emplacement dans le contrôle ImageList (assigné à la propriété ImageList) où se trouve l'image. La valeur par défaut est -1.

Attributs

Exceptions

value est inférieur à -1.

Exemples

L’exemple de code suivant montre comment créer un Label contrôle qui a une bordure en trois dimensions et une image affichée à l’aide des ImageList propriétés et ImageIndex . Le contrôle a également une légende avec un caractère mnémonique spécifié. L’exemple de code utilise les PreferredHeight propriétés et PreferredWidth pour dimensionner correctement le Label contrôle sur le formulaire sur lequel il est affiché. Cet exemple nécessite qu’un ImageList a été créé et nommé imageList1 et qu’il ait chargé deux images. L’exemple exige également que le code se trouve dans un formulaire auquel l’espace de System.Drawing noms est ajouté.

public:
   void CreateMyLabel()
   {
      // Create an instance of a Label.
      Label^ label1 = gcnew Label;
      
      // Set the border to a three-dimensional border.
      label1->BorderStyle = System::Windows::Forms::BorderStyle::Fixed3D;
      // Set the ImageList to use for displaying an image.
      label1->ImageList = imageList1;
      // Use the second image in imageList1.
      label1->ImageIndex = 1;
      // Align the image to the top left corner.
      label1->ImageAlign = ContentAlignment::TopLeft;
      
      // Specify that the text can display mnemonic characters.
      label1->UseMnemonic = true;
      // Set the text of the control and specify a mnemonic character.
      label1->Text = "First &Name:";
      
      /* Set the size of the control based on the PreferredHeight and PreferredWidth values. */
      label1->Size = System::Drawing::Size( label1->PreferredWidth, label1->PreferredHeight );
      
      //...Code to add the control to the form...
   }
public void CreateMyLabel()
{
   // Create an instance of a Label.
   Label label1 = new Label();

   // Set the border to a three-dimensional border.
   label1.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D;
   // Set the ImageList to use for displaying an image.
   label1.ImageList = imageList1;
   // Use the second image in imageList1.
   label1.ImageIndex = 1;
   // Align the image to the top left corner.
   label1.ImageAlign = ContentAlignment.TopLeft;

   // Specify that the text can display mnemonic characters.
   label1.UseMnemonic = true;
   // Set the text of the control and specify a mnemonic character.
   label1.Text = "First &Name:";
   
   /* Set the size of the control based on the PreferredHeight and PreferredWidth values. */
   label1.Size = new Size (label1.PreferredWidth, label1.PreferredHeight);

   //...Code to add the control to the form...
}
Public Sub CreateMyLabel()
    ' Create an instance of a Label.
    Dim label1 As New Label()
       
    ' Set the border to a three-dimensional border.
    label1.BorderStyle = System.Windows.Forms.BorderStyle.Fixed3D
    ' Set the ImageList to use for displaying an image.
    label1.ImageList = imageList1
    ' Use the second image in imageList1.
    label1.ImageIndex = 1
    ' Align the image to the top left corner.
    label1.ImageAlign = ContentAlignment.TopLeft
     
    ' Specify that the text can display mnemonic characters.
    label1.UseMnemonic = True
    ' Set the text of the control and specify a mnemonic character.
    label1.Text = "First &Name:"
       
    ' Set the size of the control based on the PreferredHeight and PreferredWidth values. 
    label1.Size = New Size(label1.PreferredWidth, label1.PreferredHeight)

    '...Code to add the control to the form...
End Sub

Remarques

Les ImageIndex propriétés et ImageList ne peuvent pas être utilisées en même temps que la Image propriété . Lorsque la ImageIndex propriété et ImageList les propriétés sont utilisées pour afficher une image, la Image propriété est automatiquement définie sur null.

ImageKey et ImageIndex s’excluent mutuellement, ce qui signifie que si l’un est défini, l’autre est défini sur une valeur non valide et ignoré. Si vous définissez la ImageKey propriété, la ImageIndex propriété est automatiquement définie sur -1. Sinon, si vous définissez la ImageIndex propriété, le ImageKey est automatiquement défini sur une chaîne vide («  »).

Si la valeur de la ImageList propriété est remplacée par null, la ImageIndex propriété retourne sa valeur par défaut, -1. Toutefois, la valeur affectée ImageIndex est conservée en interne et utilisée lorsqu’un autre ImageList objet est affecté à la ImageList propriété . Si le nouveau ImageList affecté à la ImageList propriété a une ImageList.ImageCollection.Count valeur de propriété inférieure ou égale à la valeur affectée à la ImageIndex propriété moins un (pour tenir compte de la collection étant un index de base zéro), la valeur de la ImageIndex propriété est ajustée à un de moins que la valeur de la Count propriété. Prenons l’exemple d’un contrôle de bouton dont ImageList la propriété a trois images et dont ImageIndex la propriété a la valeur 2. Si un nouveau ImageList qui n’a que deux images est affecté au bouton, la ImageIndex valeur passe à 1.

S’applique à

Voir aussi