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 элемент управления с трехмерной границей и изображением, отображаемым с помощью ImageList и ImageIndex свойств. Элемент управления также содержит заголовок с указанным символом mnemonic. В примере кода используются 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

Комментарии

ImageList Свойства ImageIndex нельзя использовать одновременно со свойствомImage. ImageIndex Если свойство и ImageList свойства используются для отображения изображения, Image свойство автоматически устанавливается в значение null.

ImageKey и ImageIndex являются взаимоисключающими, то есть если один задан, другой имеет недопустимое значение и игнорируется. Если задано ImageKey свойство, ImageIndex свойство автоматически устанавливается равным –1. Кроме того, если задать ImageIndex свойство, автоматически ImageKey устанавливается пустая строка ("").

ImageList Если значение свойства измененоnull, ImageIndex свойство возвращает значение по умолчанию –1. Однако назначенное ImageIndex значение сохраняется внутри системы и используется, когда другому ImageList объекту ImageList присваивается свойство. Если новое ImageList , назначенное свойству ImageList , имеет ImageList.ImageCollection.Count значение свойства, которое меньше или равно значению, назначенному ImageIndex свойству минус один (для учета коллекции, являющейся отсчитывающимся от нуля индексом), ImageIndex значение свойства корректируется на одно меньше, чем Count значение свойства. Например, рассмотрим элемент управления "Кнопка", имеющий ImageList три изображения и свойство которого ImageIndex имеет значение 2. Если кнопке назначено новое изображение ImageList , которое содержит только два изображения, ImageIndex значение изменится на 1.

См. также раздел

• Image
• ImageAlign
• ImageList