Image Property, SftTreeCell Object


	SftTreeCell.Image Property	Softel vdm, Inc.

Defines the graphic displayed in this cell.

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 SftTreeCell object.

refImageObj

Defines the graphic displayed in this cell.

Comments

The Image property defines the graphic displayed in this cell.

When using fixed height items (see Items.Style), all graphics used in a tree control as cell graphic 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 all items, so graphics used as cell graphics are never clipped vertically. To change the cell graphic size, all cell graphics must be removed first using the Items.ClearCellImages 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).

The Items.ClearCellImages method can be used to remove all cell graphics. The Image property can be set to the value Nothing (NULL), which removes the graphic from the cell.

The position of the cell graphics is determined by the Cell.ImageHAlign and Cell.ImageVAlign properties.