By: Yaron Goali (WISERBIT DOT COM) for Microncode.com

User Control: cImageList

Properties

ColourDepth [Get] - Public (Return Datatype: eilColourDepth)


Returns the ColourDepth:
No Parameters

Procedure Attributes


Attribute	Value
Description	Gets/sets the number of colours the image list will suport.
Property Browser Page	ppgControl

ColourDepth [Let] - Public


Sets the ColourDepth. NB no change at runtime unless you
call Create and rebuild the image list.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eDepth	eilColourDepth

hIml [Get] - Public (Return Datatype: Long)


Returns the ImageList handle:
No Parameters

Procedure Attributes


Attribute	Value
Description	Gets the COMCTL32 hImageList handle to the current image list, or 0 if there is no image list.
Procedure ID	Default

IconSizeX [Get] - Public (Return Datatype: Long)


Returns the icon width
No Parameters

Procedure Attributes


Attribute	Value
Description	Gets/sets the width of the images in the list. Has no effect a runtime unless you call the Create method.
Property Browser Page	ppgControl

IconSizeX [Let] - Public


Sets the icon width. NB no change at runtime unless you
call Create and add all the images in again.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lSizeX	Long

IconSizeY [Get] - Public (Return Datatype: Long)


Returns the icon height:
No Parameters

Procedure Attributes


Attribute	Value
Description	Gets/sets the height of the images in the list. Has no effect a runtime unless you call the Create method.

IconSizeY [Let] - Public


Sets the icon height. NB no change at runtime unless you
call Create and add all the images in again.

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lSizeY	Long

ImageCount [Get] - Public (Return Datatype: Integer)


Returns the number of images in the ImageList:
No Parameters

Procedure Attributes


Attribute	Value
Description	Gets the number of images in the Image List.
Property Browser Page	ppgImages,Property Category

ImagePictureStrip [Get] - Public (Return Datatype: IPicture)


Optional	ByVal/ByRef	Variable	Datatype
Optional	ByVal	vStartKey	Variant
Optional	ByVal	vEndKey	Variant
Optional	ByVal	oBackColor	OLE_COLOR(vbButtonFace)



Procedure Attributes


Attribute	Value
Description	Returns a Picture object containing a bitmap with all the image list images in a horizontal strip.

ItemCopyOfIcon [Get] - Public (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant



Procedure Attributes


Attribute	Value
Description	Makes a copy of a specified image in the image list into an icon and returns the hIcon handle. You must use DestroyIcon to free this handle.

ItemIndex [Get] - Public (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant



Procedure Attributes


Attribute	Value
Description	Returns the API index (0 based) for the image with a specified key.
Attributes	Don't show in property browser

ItemKey [Get] - Public (Return Datatype: Variant)


Returns the Key for an image:

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iIndex	Long



Procedure Attributes


Attribute	Value
Description	Returns the key for an image with the specified index.

ItemKey [Let] - Public


Sets the Key for the an image:

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	iIndex	Long
	ByVal	vKey	Variant

ItemPicture [Get] - Public (Return Datatype: IPicture)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant



Procedure Attributes


Attribute	Value
Description	Returns a Picture object containing an image in the Image List.

KeyExists [Get] - Public (Return Datatype: Boolean)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sKey	String

SystemColourDepth [Get] - Public (Return Datatype: eilColourDepth)

No Parameters

Procedure Attributes


Attribute	Value
Description	Returns the current system colour depth. Use it to determine whether to load 16 or 256 colour icons from a resource file at run-time.

Subroutines

Clear - Public


Recreates the image list. Used by the control property page to
change the size/depth:
No Parameters

Procedure Attributes


Attribute	Value
Description	Clears all images in the list and creates a new image list.

Destroy - Public


Kill the image list if we have one:
No Parameters

Procedure Attributes


Attribute	Value
Description	Deletes the image list (if any) from memory.

DrawImage - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant
	ByVal	hdc	Long
	ByVal	xPixels	Integer
	ByVal	yPixels	Integer
Optional	ByVal	bSelected(False)
Optional	ByVal	bCut(False)
Optional	ByVal	bDisabled(False)
Optional	ByVal	oCutDitherColour	OLE_COLOR(vbWindowBackground)
Optional	ByVal	hExternalIml	Long(0)



Procedure Attributes


Attribute	Value
Description	Draws an Image from the image list onto a device context.

RemoveImage - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKey	Variant



Procedure Attributes


Attribute	Value
Description	Removes an image from the image list.

SwapOrCopyImage - Public


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vKeySrc	Variant
	ByVal	vKeyDst	Variant
Optional	ByVal	eSwap	eilSwapTypes(eilSwap)



Procedure Attributes


Attribute	Value
Description	Swaps two images or copies an image to another position in the image list.

Functions

AddFromFile - Public (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sFileName	String
	ByVal	iType	ImageTypes
Optional	ByVal	vKey	Variant
Optional	ByVal	bMapSysColors	Boolean(False)
Optional	ByVal	lBackColor	OLE_COLOR(-1)
Optional	ByVal	vKeyAfter	Variant



Procedure Attributes


Attribute	Value
Description	Adds an image or series of images to the image list from a bitmap or icon file.

AddFromHandle - Public (Return Datatype: Boolean)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hImage	Long
	ByVal	iType	ImageTypes
Optional	ByVal	vKey	Variant
Optional	ByVal	lBackColor	OLE_COLOR(-1)
Optional	ByVal	vKeyAfter	Variant



Procedure Attributes


Attribute	Value
Description	Adds an image or series of images to the image list from a bitmap or icon GDI handle.

AddFromPictureBox - Public (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hdc	Long
		pic	Object
Optional	ByVal	vKey	Variant
Optional	ByVal	LeftPixels	Long(0)
Optional	ByVal	TopPixels	Long(0)
Optional	ByVal	lBackColor	OLE_COLOR(-1)

AddFromResourceID - Public (Return Datatype: Long)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lID	Long
	ByVal	hInst	Long
	ByVal	iType	ImageTypes
Optional	ByVal	vKey	Variant
Optional	ByVal	bMapSysColors	Boolean(False)
Optional	ByVal	lBackColor	OLE_COLOR(-1)
Optional	ByVal	vKeyAfter	Variant



Procedure Attributes


Attribute	Value
Description	Adds an image or series of images to the image list from a resource identifier.

Create - Public (Return Datatype: Boolean)

No Parameters

Procedure Attributes


Attribute	Value
Description	Clears the existing image list (if any) and creates a new one.

LoadFromFile - Public (Return Datatype: Boolean)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sFile	String



Procedure Attributes


Attribute	Value
Description	Loads a set of images from a file previously created with the SaveToFile method.

SaveToFile - Public (Return Datatype: Boolean)


Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sFile	String



Procedure Attributes


Attribute	Value
Description	Saves the current image list image data to a file. This can be read in at another point with LoadFromFile.