SftMask/OCX 7.0 - ActiveX Masked Edit Control

GetColorSample Method, SftPictureObject Object

Retrieves the picture object attributes defined as a color sample.

Syntax

VB.NET	object.GetColorSample(ByRef SampleColor As UInteger, ByRef FrameColor As UInteger)
VB	object.GetColorSample(SampleColor As OLE_COLOR, FrameColor As OLE_COLOR)
C#.NET	void object.GetColorSample(out uint SampleColor, out uint FrameColor);
VC++	HRESULT object->GetColorSample(OLE_COLOR* SampleColor, OLE_COLOR* FrameColor);
C	HRESULT object->raw_GetColorSample(OLE_COLOR* SampleColor, OLE_COLOR* FrameColor);

object

A SftPictureObject object.

SampleColor

Returns the current sample color. For information about color properties, please visit the applicable section "Using SftMask/OCX with ...".

FrameColor

the current border color. For information about color properties, please visit the applicable section "Using SftMask/OCX with ...".

Comments

The GetColorSample method retrieves the picture object attributes defined as a color sample.

If the current picture object is not a color sample (SftPictureObject.Type other than sftTypeColorSample), the returned color values are not valid.

The color sample is defined using the SftPictureObject.SampleColor, SftPictureObject.FrameColor, SftPictureObject.Width, SftPictureObject.Height properties or using the SftPictureObject.SetColorSample method.

See Also SftPictureObject Object | Object Hierarchy