Label.ImageIndex Eigenschaft

  • Referenz

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Ruft den Indexwert des in Label dargestellten Bilds, oder legt diesen fest.

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

Eigenschaftswert

Int32

Ein nullbasierter Index, der die Position des Bilds innerhalb des ImageList-Steuerelements (der ImageList-Eigenschaft zugewiesen) darstellt. Der Standard ist -1.

Attribute
TypeConverterAttribute

Ausnahmen

ArgumentOutOfRangeException

value ist kleiner als -1.

Beispiele

Im folgenden Codebeispiel wird das Erstellen eines Label Steuerelements mit einem dreidimensionalen Rahmen und einem Bild veranschaulicht, das mithilfe der ImageList Eigenschaften und ImageIndex angezeigt wird. Das Steuerelement verfügt auch über eine Beschriftung mit einem mnemonischen Zeichen. Der Beispielcode verwendet die PreferredHeight Eigenschaften und PreferredWidth , um das Steuerelement auf dem Label Formular, in dem es angezeigt wird, ordnungsgemäß zu vergrößern. Dieses Beispiel erfordert, dass ein ImageList mit dem Namen imageList1 erstellt und zwei Images geladen wurde. Das Beispiel erfordert auch, dass sich der Code in einem Formular befindet, in dem der System.Drawing Namespace dem Code hinzugefügt wurde.

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

Hinweise

Die ImageIndex Eigenschaften und ImageList können nicht gleichzeitig mit der Image -Eigenschaft verwendet werden. Wenn die -Eigenschaft und ImageList -ImageIndexEigenschaften zum Anzeigen eines Bilds verwendet werden, wird die Image -Eigenschaft automatisch auf nullfestgelegt.

ImageKey und ImageIndex schließen sich gegenseitig aus, d. h. wenn eine festgelegt ist, wird der andere auf einen ungültigen Wert festgelegt und ignoriert. Wenn Sie die ImageKey Eigenschaft festlegen, wird die ImageIndex Eigenschaft automatisch auf -1 festgelegt. Alternativ wird beim Festlegen der ImageIndex -Eigenschaft ImageKey automatisch eine leere Zeichenfolge ("") festgelegt.

Wenn der ImageList Eigenschaftswert in nullgeändert wird, gibt die ImageIndex Eigenschaft den Standardwert -1 zurück. Der zugewiesene ImageIndex Wert wird jedoch intern beibehalten und verwendet, wenn der ImageList -Eigenschaft ein anderes ImageList Objekt zugewiesen wird. Wenn die der Eigenschaft zugewiesene ImageList neue ImageList Eigenschaft einen ImageList.ImageCollection.Count Eigenschaftswert aufweist, der kleiner oder gleich dem der ImageIndex Eigenschaft minus 1 zugewiesenen Wert ist (um zu berücksichtigen, dass die Auflistung ein nullbasierter Index ist), wird der ImageIndex Eigenschaftswert auf eins kleiner als der Count Eigenschaftswert angepasst. Betrachten Sie beispielsweise ein Schaltflächensteuerelement, dessen ImageList Drei Bilder aufweist und dessen ImageIndex Eigenschaft auf 2 festgelegt ist. Wenn der Schaltfläche ein neues ImageList Bild mit nur zwei Bildern zugewiesen ist, ändert sich der ImageIndex Wert in 1.

Gilt für:

Weitere Informationen