Dynamsoft Home|Product Home

CapSetFrame Method

Description

Sets the values of the specified frame.

Syntax

Boolean ObjectName. CapSetFrame(Integer Index, Single Left, Single Top, Single Right, Single Bottom)

Parameters

Integer Index: specifies the values of which frame to set. The index is 0-based.

Single(float) Left: the value (in ICAP_UNITS) of the left-most edge of the specified frame.

Single(float) Top: the value (in ICAP_UNITS) of the top-most edge of the specified frame.

Single(float) Right: the value (in ICAP_UNITS) of the right-most edge of the specified frame.

Single(float) Bottom: the value (in ICAP_UNITS) of the bottom-most edge of the specified frame.

Return value

Boolean.

TRUE indicates success. FALSE indicates failure.

When an error occurs and IfThrowException property is TRUE, an exception will be thrown.

When FALSE is returned or an exception is thrown, check ErrorCode property and ErrorString property for error information.

Remarks

The default unit is assumed to be "inches" unless it has been otherwise negotiated between the application and source.

See also

CapGetFrameLeft(), CapGetFrameTop(), CapGetFrameRight(), CapGetFrameBottom()

Sample

Refer to How to negotiate ICAP_FRAMES