This documentation is archived and is not being maintained.

Label.ImageList Property

Gets or sets the ImageList that contains the images to display in the Label control.

[Visual Basic]
Public Property ImageList As ImageList
[C#]
public ImageList ImageList {get; set;}
[C++]
public: __property ImageList* get_ImageList();
public: __property void set_ImageList(ImageList*);
[JScript]
public function get ImageList() : ImageList;
public function set ImageList(ImageList);

Property Value

An ImageList that stores the collection of Image objects. The default value is a null reference (Nothing in Visual Basic).

Remarks

The ImageIndex and the ImageList properties cannot be used at the same time as the Image property. When the ImageIndex property and ImageList properties are used to display an image, the Image property is set to a null reference (Nothing in Visual Basic).

Example

The following example demonstrates how to create a Label control that has a three-dimensional border and an image displayed using the ImageList and ImageIndex properties. The control also has a caption with a mnemonic character specified. The example code uses the PreferredHeight and PreferredWidth properties to properly size the Label control on the form on which it is displayed. This example assumes that an ImageList has been created and named imageList1 and that it has loaded two images. The example also assumes that the code is within a form that has the System.Drawing namespace added to its code.

[Visual Basic] 
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


[C#] 
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...
}


[C++] 
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 = S"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...
 }
 

[JScript] 
public function CreateMyLabel()
{
   // Create an instance of a Label.
   var label1 : Label = 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 System.Drawing.Size (label1.PreferredWidth, label1.PreferredHeight);

   //...Code to add the control to the form...
}

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Label Class | Label Members | System.Windows.Forms Namespace | Image | ImageAlign | ImageIndex | ImageList

Show: