IntsCollection Object (IIntsCollection Interface)

IntsCollection object (IIntsCollection interface) in the ABBYY FineReader Engine API — Collection of int values used as parameter or return value in FineReader Engine methods.

This object represents a collection of int type variables. It serves as a storage to pass various sets of parameters into those ABBYY FineReader Engine functions that require them. It may also be return value of ABBYY FineReader Engine methods.

• 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	int	Provides access to a single element of the collection.

Methods

Name	Description
Add	Adds the specified integer value at the end of the collection.
CopyFrom	Initializes properties of the current object with values of similar properties of another object.
DeleteAll	Removes all the elements from the collection.
DeleteAt	Removes an element from the collection.
InsertAt	Inserts the specified integer value into the specified position in the collection.
Item	Provides access to a single element of the collection.

Output parameter

This collection is the output parameter of the following methods and properties:

• CreateIntsCollection method of the Engine object
• ColorHues property of the ColorObjectsProhibitingParams object
• GetPagesToProcess method of the IFileAdapter interface (Linux and Windows)
• PaperSizes and Resolutions properties of the ScanSourceCapabilities object (Windows)
• GetSelectedBlocksIndices method of the ZoomViewer object (Visual Components)
• GetSelectedBlocksIndices method and SelectedPagesIndices property of the ImageViewer object (Visual Components)
• SelectedPagesIndices property of the DocumentViewer object (Visual Components)

Input parameter

This collection is the input parameter of the following methods and properties:

• InjectTextLayer method of the Engine object
• AddImageFile, AddImageFileFromAttachment, AddImageFileFromMemory, AddImageFileWithPassword, AddImageFileWithPasswordCallback, AddImageFileFromStream, CheckTextLayer, PreprocessPages, AnalyzePages, ExportPages, RecognizePages, SplitPages, SynthesizePages, ProcessPages methods of the FRDocument object
• Renumber method of the FRPages object
• AddWordsToCacheDictionary and RecognizeBlocks methods of the FRPage object
• AddPages method of the ExportFileWriter object
• AddWords method of the Dictionary object
• RemoveColorObjectsEx method of the ImageDocument object
• ColorHues property of the ColorObjectsProhibitingParams object
• CompareDocuments method of the Comparator object
• InitializeGrid method of the TableBlock object

The input parameters below are specific to Visual Components:

• SetSelectedBlocksIndices method of the ZoomViewer object

• SetSelectedBlocksIndices method and SelectedPagesIndices property of the ImageViewer object

• OnToolChangeBlockRegion, OnDeleteBlocks, OnReadBlocks method of the IZoomViewerEvents interface

• OnReadBlocks, OnToolChangeBlockRegion, OnDeleteBlocks, OnReadBlocks, OnEditImages, OnCorrectResolution, OnCropImages, OnSplitImages method of the IImageViewerEvents interface

• SelectedPagesIndices property of the DocumentViewer object

• OnExportPages, OnRenumberingPages methods of the IDocumentViewerEvents interface

Samples

C# code

 
for( int i = 0; i < Document.Pages.Count; i++ )
{
 if( Document.Pages[i].PageStructureOutOfDate )
 {
  pageIndices.Add( i );
 }
}

The object is used in the following code samples:

• Linux: BatchProcessing
• Windows: BatchProcessing and VisualComponents; and demo tools: BatchProcessingRecognition, Classification

See also

Working with Collections

Working with Properties