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)

Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs

Adds the specified icon to the ImageList.

C#
public void Add(System.Drawing.Icon value);

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.

C#
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);
    }
}

Remarks

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

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

Add(Image)

Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs

Adds the specified image to the ImageList.

C#
public void Add(System.Drawing.Image value);

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.

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

Add(Image, Color)

Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs

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

C#
public int Add(System.Drawing.Image value, System.Drawing.Color transparentColor);

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.

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

Add(String, Icon)

Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs

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

C#
public void Add(string key, System.Drawing.Icon icon);

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.

Applies to

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

Add(String, Image)

Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs
Source:
ImageList.ImageCollection.cs

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

C#
public void Add(string key, System.Drawing.Image image);

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

.NET Framework 4.8.1 and other versions
Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9