CellPicture Property, SftTree Object


	SftTree.CellPicture Property	Softel vdm, Inc.

Defines the graphic displayed as an item's cell graphic.

Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.Picture instead

Syntax

Get
	VB.NET	refPictureObj = object.get_CellPicture(ByVal ItemIndex As Integer, ByVal ColIndex As Short) As System.Drawing.Image
	VB	Set refPictureObj = object.CellPicture(ByVal ItemIndex As Long, ByVal ColIndex As Integer) As IPictureDisp
	C#.NET	System.Drawing.Image refPictureObj = object.get_CellPicture(int ItemIndex, short ColIndex);
	VC++	IPictureDisp* refPictureObj = object->GetCellPicture(long ItemIndex, short ColIndex);
	C	HRESULT object->get_CellPicture(long ItemIndex, short ColIndex, IPictureDisp** refPictureObj);
	Delphi	refPictureObj := object.CellPicture[ItemIndex : Integer; ColIndex : Smallint] : TPicture;
Put
	VB.NET	object.let_CellPicture(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal refPictureObj As System.Drawing.Image)
	VB	object.CellPicture(ByVal ItemIndex As Long, ByVal ColIndex As Integer) = refPictureObj As IPictureDisp
	C#.NET	void object.let_CellPicture(int ItemIndex, short ColIndex, System.Drawing.Image refPictureObj);
	VC++	void object->PutCellPicture(long ItemIndex, short ColIndex, IPictureDisp* refPictureObj);
	C	HRESULT object->put_CellPicture(long ItemIndex, short ColIndex, IPictureDisp* refPictureObj);
	Delphi	procedure object._Set_CellPicture(ItemIndex : Integer, ColIndex : Smallint, refPictureObj : TPicture);
PutRef
	VB.NET	object.set_CellPicture(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal refPictureObj As System.Drawing.Image)
	VB	Set object.CellPicture(ByVal ItemIndex As Long, ByVal ColIndex As Integer) = refPictureObj As IPictureDisp
	C#.NET	void object.set_CellPicture(int ItemIndex, short ColIndex, System.Drawing.Image refPictureObj);
	VC++	void object->PutRefCellPicture(long ItemIndex, short ColIndex, IPictureDisp* refPictureObj);
	C	HRESULT object->putref_CellPicture(long ItemIndex, short ColIndex, IPictureDisp* refPictureObj);
	Delphi	object.CellPicture[ItemIndex : Integer; ColIndex : Smallint] := refPictureObj : TPicture;

object

A SftTree object.

ItemIndex

The zero-based item index. The combination of ItemIndex and ColIndex describes an individual cell.

ColIndex

The zero-based column number. The combination of ItemIndex and ColIndex describes an individual cell.

refPictureObj

Defines the graphic displayed as the item's cell graphic. The refPictureObj object must represent a bitmap, icon or Windows metafile. If a bitmap is used, the top, left pixel of each graphic must contain the background color. This color will be replaced by the actual background when the graphic is displayed. For information about picture properties, please visit the applicable section "Using SftTree/OCX with ...".

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Cell.Image.Picture instead - The Cell.Image property can be used with various graphic types (bitmaps, icons, ImageLists, Windows metafiles, built-in images, etc.).

The CellPicture property defines the graphic displayed as an item's cell graphic.

The CellPicture and CellPictureH properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).

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.

The Items.ClearCellImages method can be used to remove all cell graphics. The CellPicture 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.

Using PutRef (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using Put instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of Put, PutRef is the preferred method.