StringsCollection Object (IStringsCollection Interface)

StringsCollection object (IStringsCollection interface) in the ABBYY FineReader Engine API — Collection of strings used as parameter or return value in FineReader Engine methods.

This object represents a collection of strings. It serves as a storage to pass various sets of parameters into those FineReader Engine functions that require them. It may also be return value of 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	BSTR	Provides access to a single element of the collection.

Methods

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

Output parameter

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

• CreateStringsCollection method of the Engine object
• PDFFontNames property, ExportPages method of the FRDocument object
• CategoryLabels, Languages properties of the Model object
• AxisLabels property of the ConfusionMatrix object
• Scan method of the ScanSource object (Windows)

Input parameter

This object is passed as an input parameter to the following methods:

• AddWords, DeleteWords methods of the Dictionary object
• MergePatterns method of the Engine object

Samples

The object is used in the following code samples:

• Linux: CommandLineInterface
• Windows: CommandLineInterface, and demo tools: Classification

See also

Working with Collections

Working with Properties