SetCellColorSample Method, SftTree Object


	SftTree.SetCellColorSample Method	Softel vdm, Inc.

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

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

Syntax

		VB.NET	object.SetCellColorSample(ByVal ItemIndex As Integer, ByVal ColIndex As Short, ByVal Clr As System.Drawing.Color, ByVal FrameClr As System.Drawing.Color, ByVal WidthPix As Short, ByVal HeightPix As Short)
		VB	object.SetCellColorSample(ByVal ItemIndex As Long, ByVal ColIndex As Integer, ByVal Clr As OLE_COLOR, ByVal FrameClr As OLE_COLOR, ByVal WidthPix As Integer, ByVal HeightPix As Integer)
		C#.NET	void object.SetCellColorSample(int ItemIndex, short ColIndex, System.Drawing.Color Clr, System.Drawing.Color FrameClr, short WidthPix, short HeightPix);
		VC++	HRESULT object->SetCellColorSample(long ItemIndex, short ColIndex, OLE_COLOR Clr, OLE_COLOR FrameClr, short WidthPix, short HeightPix);
		C	HRESULT object->raw_SetCellColorSample(long ItemIndex, short ColIndex, OLE_COLOR Clr, OLE_COLOR FrameClr, short WidthPix, short HeightPix);
		Delphi	procedure object.SetCellColorSample(ItemIndex : Integer, ColIndex : Smallint, Clr : TColor, FrameClr : TColor, WidthPix : Smallint, HeightPix : Smallint);

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.

Clr

Defines the color sample displayed as the item's cell graphic. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".

FrameClr

Defines the color value used to outline the color sample rectangle. If -1 is used, no outline is drawn. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".

WidthPix

The width of the color sample rectangle in pixels.

HeightPix

The height of the color sample rectangle in pixels.

Comments

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

The SetCellColorSample method defines the color sample displayed as an item's cell graphic.

The SetCellColorSample method is used to define a cell's optional graphic component to display a color sample rectangle. The settings can be retrieved using the GetCellColorSample 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 WidthPix and HeightPix parameters can be set to the value 0, 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.