IsEmpty Method of the FRPage Object

IsEmpty method of the FRPage Object in the ABBYY FineReader Engine API — Checks whether the page is empty (contains no relevant objects) using EmptyPageDetectionParams to set page rectangle and tolerance.

This method checks if the page is empty. It uses the same parameters as analysis methods to find out if the page contains any relevant objects, for example, text, tables, or pictures. You can use the EmptyPageDetectionParams parameter to set the page rectangle, so that any garbage on the margins does not affect the result, and specify the maximum number of objects that a page can contain and still be considered empty.

Syntax

C++

HRESULT IsEmpty(
  IObjectsExtractionParams*  ExtractionParams,
  IRecognizerParams*         RecognizerParams,
  IEmptyPageDetectionParams* EmptyPageDetectionParams,
  VARIANT_BOOL*              Result
);

C#

bool IsEmpty(
  IObjectsExtractionParams  ExtractionParams,
  IRecognizerParams         RecognizerParams,
  IEmptyPageDetectionParams EmptyPageDetectionParams
);

Visual Basic .NET

Function IsEmpty( _
  [ExtractionParams As IObjectsExtractionParams = Nothing], _
  [RecognizerParams As IRecognizerParams = Nothing], _
  [EmptyPageDetectionParams As IEmptyPageDetectionParams = 0] _
) As Boolean

Parameters

ExtractionParams

[in] Refers to the ObjectsExtractionParams object that stores parameters of objects extraction. This parameter may be 0. In this case, the objects are extracted with default parameters, or, if a profile has been loaded, the parameters set by this profile are used.

RecognizerParams

[in] Refers to the RecognizerParams object that stores recognition parameters necessary for layout analysis (e.g., recognition language). This parameter may be 0. In this case, the default parameters are used, or, if a profile has been loaded, the parameters set by this profile are used.

EmptyPageDetectionParams

[in] Refers to the EmptyPageDetectionParams object that stores parameters of empty page detection, such as the page margins which must not be considered, and the number of objects which are allowed on an empty page. This parameter may be 0. In this case, the default parameters are used, or, if a profile has been loaded, the parameters set by this profile are used.

Result

[out, retval] Receives the result of the method’s work. This variable is set to TRUE if the page is found to be empty, and to FALSE if it is not empty (contains some text, pictures or other relevant objects).

Return values

This method has no specific return values. It returns standard return codes of ABBYY FineReader Engine functions.

See also

FRPage