Label.ImageIndex 属性

定义

命名空间:

System.Windows.Forms

程序集:

System.Windows.Forms.dll

获取或设置在 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

属性值

Int32

从零开始的索引，它表示图像在 ImageList 控件（分配给 ImageList 属性）中所处的位置。 默认值为 -1。

属性

TypeConverterAttribute

例外

ArgumentOutOfRangeException

value 小于 -1。

示例

下面的代码示例演示如何创建一个Label控件，该控件具有三维边框和使用 和 ImageIndex 属性显示ImageList的图像。 控件还具有指定助记符的标题。 示例代码使用 PreferredHeight 和 PreferredWidth 属性在显示控件的窗体上正确调整控件的大小 Label 。 此示例要求已创建并 ImageList 命名为 imageList1 且已加载两个映像。 该示例还要求代码位于将命名空间添加到其代码的窗体 System.Drawing 中。

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

注解

ImageIndex和 ImageList 属性不能与 属性同时使用Image。 当 属性 ImageIndex 和 ImageList 属性用于显示图像时，属性 Image 将自动设置为 null。

ImageKey 和 ImageIndex 是互斥的，这意味着如果设置了一个，另一个设置为无效值并被忽略。 如果设置 ImageKey 属性，则 ImageIndex 属性将自动设置为 -1。 或者，如果设置 ImageIndex 属性，则 ImageKey 会自动将 设置为空字符串 (“”) 。

ImageList如果属性值更改为 null，则ImageIndex属性返回其默认值 -1。 但是，分配 ImageIndex 的值在内部保留，并在将另一个 ImageList 对象分配给 ImageList 属性时使用。 如果分配给属性ImageList.ImageCollection.CountImageList的新ImageList属性值小于或等于分配给ImageIndex属性的值减去 1 (以说明集合是一个从零开始的索引) ，则ImageIndex属性值将调整为比Count属性值少一个。 例如，假设一个按钮控件具有 ImageList 三个图像，其 ImageIndex 属性设置为 2。 如果将只有两个图像的新 ImageList 分配给按钮，该值 ImageIndex 将更改为 1。

另请参阅

• Image
• ImageAlign
• ImageList