CellPictureH Property, SftTree Object


	SftTree.CellPictureH 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.PictureH instead

Syntax

Get
	VB.NET	Handle = object.get_CellPictureH(ByVal ItemIndex As Integer, ByVal ColIndex As Short) As Integer
	VB	Handle = object.CellPictureH(ByVal ItemIndex As Long, ByVal ColIndex As Integer) As OLE_HANDLE
	C#.NET	int Handle = object.get_CellPictureH(int ItemIndex, short ColIndex);
	VC++	OLE_HANDLE Handle = object->CellPictureH[long ItemIndex][short ColIndex]; OLE_HANDLE Handle = object->GetCellPictureH(long ItemIndex, short ColIndex);
	C	HRESULT object->get_CellPictureH(long ItemIndex, short ColIndex, OLE_HANDLE* Handle);
	Delphi	Handle := object.CellPictureH[ItemIndex : Integer; ColIndex : Smallint] : Cardinal;
Put
	VB.NET	object.set_CellPictureH(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal Handle As Integer)
	VB	object.CellPictureH(ByVal ItemIndex As Long, ByVal ColIndex As Integer) = Handle As OLE_HANDLE
	C#.NET	void object.set_CellPictureH(int ItemIndex, short ColIndex, int Handle);
	VC++	OLE_HANDLE object->CellPictureH[long ItemIndex][short ColIndex] = Handle; void object->PutCellPictureH(long ItemIndex, short ColIndex, OLE_HANDLE Handle);
	C	HRESULT object->put_CellPictureH(long ItemIndex, short ColIndex, OLE_HANDLE Handle);
	Delphi	object.CellPictureH[ItemIndex : Integer; ColIndex : Smallint] := Handle : Cardinal;

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.

Handle

A bitmap handle. Defines the graphic displayed as the item's cell graphic. This bitmap handle has to remain valid until the tree control no longer uses it. The application has to destroy the bitmap handle once it is no longer needed. 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.

Comments

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

The CellPictureH 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 CellPictureH property can be set to the value NULL, which removes the graphic from the cell.

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