ListImage class

A ListImage is one picture inside an ImageList's ListImages collection. Returned from ListImages.Add and from ListImages.Item.

The class is tagged [COMCreatable(False)] --- user code never instantiates a ListImage directly; the ListImages collection creates them as part of its Add method.

Dim img As ListImage = ImageList1.ListImages.Add(, "open", LoadPicture("open.ico"))
img.Tag = "Open document command"

Properties

Index

The 1-based position of the image within the parent collection. Long, read-only. Equals ListImages.Item(key).Index for the same image.

Key

The string key the image was added under. String. Default: empty string. Lookups through ListImages.Item accept either the numeric Index or the string Key.

Picture

The original StdPicture that was passed to ListImages.Add. StdPicture. The image list also keeps an internal scaled bitmap copy; modifying the returned Picture does not change what the list renders.

Tag

Arbitrary data the application can attach to the image. Variant.

Methods

Draw

Renders the image into a Win32 device context at a given position. Useful for owner-draw scenarios where the application needs to paint the icon itself rather than going through a consumer control.

Syntax: object.Draw hDC [, x [, y [, Style ] ] ]

hDC

An OLE_HANDLE to the destination device context.

x

optional A Variant containing the horizontal pixel offset. Default: 0.

y

optional A Variant containing the vertical pixel offset. Default: 0.

Style

optional A combination of ImlDrawConstants flags controlling the draw mode (normal, transparent, masked, selected, focused). Multiple flags can be Or-combined.

Private Sub PictureBox1_Paint()
    ImageList1.ListImages("doc").Draw _
        PictureBox1.hDC, 0, 0, _
        ImlDrawTransparent Or ImlDrawSelected
End Sub

ExtractIcon

Returns a fresh StdPicture containing the image rendered as an HICON. Distinct from the Picture property, which returns the original bitmap; ExtractIcon is a new icon built from the cached bitmap with transparency applied.

Syntax: object.ExtractIcon As IPictureDisp

The returned IPictureDisp owns its icon handle and destroys it when it goes out of scope.

See Also

• ImageList -- the parent control
• ListImages -- the collection holding ListImage instances
• ImlDrawConstants -- the Style flag combinations for Draw