LayoutBlocks Object (ILayoutBlocks Interface)

LayoutBlocks object (ILayoutBlocks interface) in the ABBYY FineReader Engine API — Collection of Block objects on a Layout; provides standard FineReader Engine collection functionality plus IndexOf and typed AddNew.

This object represents a collection of layout blocks (Block objects). It is a subobject of a Layout object, and it serves as a storage of Layout blocks.

The object provides standard collection functionality. See Working with Collections for details.

• The indexing of ABBYY FineReader Engine collections starts with 0.
• The foreach statement in C# (for each in Visual Basic .NET) can be used to manipulate the collection.

Properties

Name	Type	Description
Application	Engine, read-only	Returns the Engine object.
Count	int, read-only	Stores the number of elements in the collection.
Element	Block, read-only	Provides access to a single element of the collection.

Methods

Name	Description
AddNew	Creates a block object of the specified type and adds it into the collection.
DeleteAll	Removes all the elements from the collection.
DeleteAt	Removes an element from the collection.
IndexOf	Returns the index of a block in the collection.
Item	Provides access to an element of the collection.

Related objects

Windows

Linux and macOS

Object Diagram

Samples

C# code

FREngine.IFRDocument frDoc;
// Iterates blocks of layout
for (int iPage = 0; iPage < frDoc.Pages.Count; iPage++)
{
 FREngine.IFRPage page = frDoc.Pages[iPage];
 FREngine.ILayout layout = page.Layout;
 int blocksCount = layout.Blocks.Count;
 for (int iBlock = 0; iBlock < blocksCount; iBlock++)
 {
  FREngine.IBlock block = layout.Blocks[iBlock];
  ...
 }
}

The object is used in the following code samples:

• Linux: CustomLanguage
• Windows: CustomLanguage, RecognizedTextProcessing; and demo tools: Engine Predefined Processing Profiles

See also

Block

Layout

Working with Layout and Blocks

Working with Collections

Working with Properties