SetCellPictureImage Method, SftTree Object


	SftTree.SetCellPictureImage Method	Softel vdm, Inc.

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

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

Syntax

		VB.NET	object.SetCellPictureImage(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal ImgListObj As Object, ByVal ImgIndex As Short)
		VB	object.SetCellPictureImage(ByVal ItemIndex As Long, ByVal ColIndex As Integer, ByVal ImgListObj As Object, ByVal ImgIndex As Integer)
		C#.NET	void object.SetCellPictureImage(int ItemIndex, short ColIndex, object ImgListObj, short ImgIndex);
		VC++	HRESULT object->SetCellPictureImage(long ItemIndex, short ColIndex, LPDISPATCH ImgListObj, short ImgIndex);
		C	HRESULT object->raw_SetCellPictureImage(long ItemIndex, short ColIndex, LPDISPATCH ImgListObj, short ImgIndex);
		Delphi	procedure object.SetCellPictureImage(ItemIndex : Integer, ColIndex : Smallint, ImgListObj : IDispatch, ImgIndex : Smallint);

object

A SftTree object.

ItemIndex

The zero-based index of the item. 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.

ImgListObj

An ImageList control supporting the IImageList interface. This ImageList object contains the graphics used to display the cell's graphic component. May be set to the value Nothing (NULL), which removes the graphic from the cell.

ImgIndex

The one-based index of the image in the ImageList control to be used as the cell's graphic component.

Comments

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

The SetCellPictureImage method defines the graphic displayed as an item's cell graphic.

The SetCellPictureImage method is used to set a cell's optional graphic component using an ImageList control. It can be retrieved using the Cell.Image.GetImageList method.

When using fixed height items (see Items.Style), all graphics used in a tree control as Cell.Image property 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.Image property 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 ImgListObj parameter can be set to the value Nothing (NULL), which removes the graphic from the cell.

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