SftBoxCell.GetColorSample Method	Softel vdm, Inc.

Defines a color sample as the cell's picture component.

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

Syntax       

		VB.NET	object.GetColorSample(ByRef WidthPix As Integer, ByRef HeightPix As Integer, ByRef Sample As UInteger, ByRef Border As UInteger)
		VB	object.GetColorSample(WidthPix As Integer, HeightPix As Integer, Sample As OLE_COLOR, Border As OLE_COLOR)
		C#.NET	void object.GetColorSample(out int WidthPix, out int HeightPix, out uint Sample, out uint Border);
		VC++	HRESULT object->GetColorSample(int* WidthPix, int* HeightPix, OLE_COLOR* Sample, OLE_COLOR* Border);
		C	HRESULT object->raw_GetColorSample(int* WidthPix, int* HeightPix, OLE_COLOR* Sample, OLE_COLOR* Border);
		Delphi	procedure object.GetColorSample(out WidthPix : Integer, out HeightPix : Integer, out Sample : Cardinal, out Border : Cardinal);

object

A SftBoxCell object.

WidthPix

Returns the width of the color sample, in pixels. If a color sample has not been defined, 0 is returned.

HeightPix

Returns the height of the color sample, in pixels. If a color sample has not been defined, 0 is returned.

Sample

Returns the color used to fill the color sample. If a color sample has not been defined, -1 is returned.

Border

Returns the color used to frame the color sample. If -1 is returned, the color sample has no border. The HeightPix and WidthPix parameters define the overall size of the color sample, including the border (if used).

Comments

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

The GetColorSample method defines a color sample as the cell's picture component.

The color sample is defined using the Cell.Image.SampleColor, Cell.Image.FrameColor, Cell.Image.Height and Cell.Image.Width properties.

A cell picture component can be used to display a color sample, a small framed box filled with the specified color. This color sample replaces the picture component defined using the SftBoxCell.Picture property.