ImageList.ImageCollection.Add Method

Definition

Adds the specified object to the ImageList.

Overloads

Add(Icon)

Adds the specified icon to the ImageList.

Add(Image)

Adds the specified image to the ImageList.

Add(Image, Color)

Adds the specified image to the ImageList, using the specified color to generate the mask.

Add(String, Icon)

Adds an icon with the specified key to the end of the collection.

Add(String, Image)

Adds an image with the specified key to the end of the collection.

Add(Icon)

Adds the specified icon to the ImageList.

public:
 void Add(System::Drawing::Icon ^ value);
public void Add (System.Drawing.Icon value);
member this.Add : System.Drawing.Icon -> unit
Public Sub Add (value As Icon)

Parameters

value
Icon

An Icon to add to the list.

Exceptions

value is null

-or-

value is not an Icon.

Examples

The following code example demonstrates constructing an ImageList, adding images to the Images property, setting the ImageSize property, and using the Draw method. To run this example, place it in a form that contains a button named Button1. The example assumes the existence of FeatherTexture.bmp and Gone Fishing.bmp at c:\Windows\. Change the example accordingly if the bitmaps do not exist on your system or exist at another location.

internal:
   System::Windows::Forms::ImageList^ ImageList1;

private:

   // Create an ImageList Object, populate it, and display
   // the images it contains.
   void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      
      // Construct the ImageList.
      ImageList1 = gcnew ImageList;
      
      // Set the ImageSize property to a larger size 
      // (the default is 16 x 16).
      ImageList1->ImageSize = System::Drawing::Size( 112, 112 );
      
      // Add two images to the list.
      ImageList1->Images->Add( Image::FromFile( "c:\\windows\\FeatherTexture.bmp" ) );
      ImageList1->Images->Add( Image::FromFile( "C:\\windows\\Gone Fishing.bmp" ) );
      
      // Get a Graphics object from the form's handle.
      Graphics^ theGraphics = Graphics::FromHwnd( this->Handle );
      
      // Loop through the images in the list, drawing each image.
      for ( int count = 0; count < ImageList1->Images->Count; count++ )
      {
         ImageList1->Draw( theGraphics, Point(85,85), count );
         
         // Call Application.DoEvents to force a repaint of the form.
         Application::DoEvents();
         
         // Call the Sleep method to allow the user to see the image.
         System::Threading::Thread::Sleep( 1000 );

      }
   }
internal System.Windows.Forms.ImageList ImageList1;

// Create an ImageList Object, populate it, and display
// the images it contains.
private void Button1_Click(System.Object sender, 
    System.EventArgs e)
{

    // Construct the ImageList.
    ImageList1 = new ImageList();

    // Set the ImageSize property to a larger size 
    // (the default is 16 x 16).
    ImageList1.ImageSize = new Size(112, 112);

    // Add two images to the list.
    ImageList1.Images.Add(
        Image.FromFile("c:\\windows\\FeatherTexture.bmp"));
    ImageList1.Images.Add(
        Image.FromFile("C:\\windows\\Gone Fishing.bmp"));

    // Get a Graphics object from the form's handle.
    Graphics theGraphics = Graphics.FromHwnd(this.Handle);

    // Loop through the images in the list, drawing each image.
    for(int count = 0; count < ImageList1.Images.Count; count++)
    {
        ImageList1.Draw(theGraphics, new Point(85, 85), count);

        // Call Application.DoEvents to force a repaint of the form.
        Application.DoEvents();

        // Call the Sleep method to allow the user to see the image.
        System.Threading.Thread.Sleep(1000);
    }
}

Friend WithEvents ImageList1 As System.Windows.Forms.ImageList

' Create an ImageList Object, populate it, and display
' the images it contains.
Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    ' Construct the ImageList.
    ImageList1 = New ImageList

    ' Set the ImageSize property to a larger size 
    ' (the default is 16 x 16).
    ImageList1.ImageSize = New Size(112, 112)

    ' Add two images to the list.
    ImageList1.Images.Add(Image.FromFile _
        ("c:\windows\FeatherTexture.bmp"))
    ImageList1.Images.Add _
        (Image.FromFile("C:\windows\Gone Fishing.bmp"))

    Dim count As System.Int32

    ' Get a Graphics object from the form's handle.
    Dim theGraphics As Graphics = Graphics.FromHwnd(Me.Handle)

    ' Loop through the images in the list, drawing each image.
    For count = 0 To ImageList1.Images.Count - 1
        ImageList1.Draw(theGraphics, New Point(85, 85), count)

        ' Call Application.DoEvents to force a repaint of the form.
        Application.DoEvents()

        ' Call the Sleep method to allow the user to see the image.
        System.Threading.Thread.Sleep(1000)
    Next
End Sub

Remarks

The Icon is converted to a Bitmap before it is added to the list.

Add(Image)

Adds the specified image to the ImageList.

public:
 void Add(System::Drawing::Image ^ value);
public void Add (System.Drawing.Image value);
member this.Add : System.Drawing.Image -> unit
Public Sub Add (value As Image)

Parameters

value
Image

A Bitmap of the image to add to the list.

Exceptions

The image being added is null.

The image being added is not a Bitmap.

Add(Image, Color)

Adds the specified image to the ImageList, using the specified color to generate the mask.

public:
 int Add(System::Drawing::Image ^ value, System::Drawing::Color transparentColor);
public int Add (System.Drawing.Image value, System.Drawing.Color transparentColor);
member this.Add : System.Drawing.Image * System.Drawing.Color -> int
Public Function Add (value As Image, transparentColor As Color) As Integer

Parameters

value
Image

A Bitmap of the image to add to the list.

transparentColor
Color

The Color to mask this image.

Returns

The index of the newly added image, or -1 if the image cannot be added.

Exceptions

The image being added is null.

The image being added is not a Bitmap.

Add(String, Icon)

Adds an icon with the specified key to the end of the collection.

public:
 void Add(System::String ^ key, System::Drawing::Icon ^ icon);
public void Add (string key, System.Drawing.Icon icon);
member this.Add : string * System.Drawing.Icon -> unit

Parameters

key
String

The name of the icon.

icon
Icon

The Icon to add to the collection.

Exceptions

icon is null.

Remarks

The name of an image corresponds to its key in the ImageList.ImageCollection. An image key is not case-sensitive.

Add(String, Image)

Adds an image with the specified key to the end of the collection.

public:
 void Add(System::String ^ key, System::Drawing::Image ^ image);
public void Add (string key, System.Drawing.Image image);
member this.Add : string * System.Drawing.Image -> unit

Parameters

key
String

The name of the image.

image
Image

The Image to add to the collection.

Exceptions

image is null.

Remarks

The name of an image corresponds to its key in the ImageList.ImageCollection. An image key is not case-sensitive.

Applies to