Image Property, SftTreeItem Object


	SftTreeItem.Image Property	Softel vdm, Inc.

Defines the item graphic displayed in this item.

Syntax

Get
	VB.NET	refImageObj = object.Image As SftPictureObject
	VB	Set refImageObj = object.Image As SftPictureObject
	C#.NET	SftPictureObject refImageObj = object.Image;
	VC++	ISftPictureObject* refImageObj = object->Image; ISftPictureObject* refImageObj = object->GetImage();
	C	HRESULT object->get_Image(ISftPictureObject** refImageObj);
	Delphi	refImageObj := object.Image : ISftPictureObject;
Put
	VB.NET	object.Image = refImageObj As SftPictureObject
	VB	object.Image = refImageObj As SftPictureObject
	C#.NET	SftPictureObject object.Image = refImageObj;
	VC++	ISftPictureObject* object->Image = refImageObj; void object->PutImage(ISftPictureObject* refImageObj);
	C	HRESULT object->put_Image(ISftPictureObject* refImageObj);
	Delphi	object.Image := refImageObj : ISftPictureObject;

object

A SftTreeItem object.

refImageObj

Defines the item graphic displayed in this item.

Comments

The Image property defines the item graphic displayed in this item.

The Image property is used to override the default item graphic defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties. These default graphics must be defined for item graphics to be shown.

The Image property can be set before the default graphics have been defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties, but item graphics are not shown until these default graphics are defined.

When using fixed height items (see Items.Style), all graphics used in a tree control as Image, Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for items, so graphics used as Image property are never clipped vertically. To change the item graphic size, all item graphics must be removed first using the Items.ClearItemImages method.

When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.

If the image object refImageObj defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see Bitmap Transparency).

If an item is disabled (see Item.Enabled property), the graphic is drawn in a "grayed" fashion, if it is based on a bitmap. Other image types, like color samples, .NET image objects, etc., must be explicitly replaced with a grayed image if a different rendering of a disabled image is desired.

The Image property can be set to the value Nothing (NULL), which restores the default graphic.

The Items.ItemImageAlign property can be used to align item graphics on lower levels with higher level cells.

The VAlignStyle property can be used to define the vertical alignment of item graphics.