Returns the value (in ICAP_UNITS) of the bottom-most edge of the specified frame.

Namespace: Dynamsoft.DotNet.TWAIN
Assembly: DynamicDotNetTWAIN (in DynamicDotNetTWAIN.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C#
public float CapGetFrameBottom(
	int iIndex
)
Visual Basic
Public Function CapGetFrameBottom ( _
	iIndex As Integer _
) As Single

Parameters

iIndex
Type: System..::..Int32
Specifies the value of which frame to get. The index is 0-based.

Return Value

The data type of the return value is Single (float).

Remarks

The unit of CapGetFrameBottom() is determined by ICAP_UNITS capability. The default unit is assumed to be "inches" unless it has been otherwise negotiated between the application and source. CapGetFrameBottom() is different from ImageLayoutFrameBottom property. CapGetFrameBottom() is part of ICAP_FRAMES capability negotiation. It can return the value of any frames in a page. ImageLayoutFrameBottom property only returns the value of the current frame which is being transferred. It is valid only in OnPreTransfer and OnPostTransfer event.

Exceptions

ExceptionCondition
Dynamsoft.DotNet.TWAIN..::..TwainException When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString.

See Also