SetCellColorSample Method, VirtualItem Object


	VirtualItem.SetCellColorSample Method	Softel vdm, Inc.

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

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

Syntax

		VB.NET	object.SetCellColorSample(ByVal ColIndex As Short, ByVal Clr As UInteger, ByVal FrameClr As UInteger, ByVal WidthPix As Short, ByVal HeightPix As Short)
		VB	object.SetCellColorSample(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(short ColIndex, uint Clr, uint FrameClr, short WidthPix, short HeightPix);
		VC++	HRESULT object->SetCellColorSample(short ColIndex, OLE_COLOR Clr, OLE_COLOR FrameClr, short WidthPix, short HeightPix);
		C	HRESULT object->raw_SetCellColorSample(short ColIndex, OLE_COLOR Clr, OLE_COLOR FrameClr, short WidthPix, short HeightPix);
		Delphi	procedure object.SetCellColorSample(ColIndex : Smallint, Clr : Cardinal, FrameClr : Cardinal, WidthPix : Smallint, HeightPix : Smallint);

object

A VirtualItem object.

ColIndex

The zero-based column number. The combination of ColIndex and the VirtualItem event's RowIndex parameter describes an individual cell.

Clr

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

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 VirtualItem.Item.Cell.Image.SetColorSample instead

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

The VirtualItem.SetCellColorSample property is used while handling a VirtualItem event to define the color sample displayed as the item's cell graphic. The item is described by the VirtualItem event's RowIndex parameter.