HeaderPane
Main
Hide
Share Link
Print

SftBoxCell.GetColorSampleV Method

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

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

Used with Internet Explorer/VBScript only

Syntax

C#void object.GetColorSampleV(out object WidthPix, out object HeightPix, out object Sample, out object Border);
VB.NETobject.GetColorSampleV(ByRef WidthPix As Object, ByRef HeightPix As Object, ByRef Sample As Object, ByRef Border As Object)
C++HRESULT object->GetColorSampleV(const _variant_t&* WidthPix, const _variant_t&* HeightPix, const _variant_t&* Sample, const _variant_t&* Border);
CHRESULT object->raw_GetColorSampleV(VARIANT* WidthPix, VARIANT* HeightPix, VARIANT* Sample, VARIANT* Border);
VBobject.GetColorSampleV(WidthPix As Variant, HeightPix As Variant, Sample As Variant, Border As Variant)

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

Used with Internet Explorer/VBScript only

The GetColorSampleV 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 Cell.Picture property.

See Also SftBoxCell Object | Object Hierarchy


Last Updated 11/03/2026 - (email)
© 2026 Softel vdm, Inc.