SortedBlocks Property of the Layout Object

SortedBlocks property of the Layout Object in the ABBYY FineReader Engine API — Returns the logically ordered collection of blocks of the layout, sorted by upper-left corner (left-to-right, then top-to-bottom); grouping behavior configurable via SortingBlocksParams.

Returns the logically ordered collection of the blocks of the layout.

This collection contains the same blocks that are returned by the Blocks property. They are sorted by the position of upper left corner of each block, first in left-to-right, then in top-to-bottom direction. The blocks that are close together will be considered as part of one logical group. You may set up the acceptable gap between the blocks belonging to the same group using the SortingBlocksParams object.

See example

Syntax

C++

HRESULT get_SortedBlocks(
  ISortingBlocksParams*   SortingBlocksParams,
  ILayoutBlocks**         Result
);

C#

ILayoutBlocks get_SortedBlocks( ISortingBlocksParams SortingBlocksParams );

Visual Basic .NET

ReadOnly Property SortedBlocks([SortingBlocksParams As ISortingBlocksParams = Nothing]) As ILayoutBlocks

Parameters

SortingBlocksParams

[in] This variable describes the SortingBlocksParams object that contains the parameters of combining the blocks into groups. This parameter is optional: you may pass NULL to use the default settings.

Result

[out, retval] A pointer to ILayoutBlocks* pointer variable that receives the interface pointer of the output LayoutBlocks object.

Return values

This function has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

Layout

LayoutBlocks