Add Method

Add method in the ABBYY FineReader Engine API — common method that adds an existing object at the end of a FineReader Engine collection.

This is a common method. Any platform-specific implementation limitations will be listed at the top of the topics for the objects using this method.

This method adds an existing object at the end of the collection.

Syntax

C++

HRESULT Add( I<ElementType>* Value );

C#

void Add( I<ElementType> Value );

Visual Basic .NET

Sub Add(Value As I<ElementType>)

Parameters

Value

[in] Contains the newly added element. ElementType is the type of the objects forming the collection.

Return values

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

Remarks

The table below describes the collections which provide this method and the types of elements in the collections:

Collection type	Element type
ClassificationObjects	ClassificationObject
IntsCollection	int
OfficeConverters Note: Collection is implemented for Windows and Linux.	OfficeConverterTypeEnum
RegionsCollection	Region
SpellReplacementCollection Note: Collection available for Windows.	SpellReplacement
StringsCollection	BSTR
TrainingImagesCollection	TrainingImage

Samples

C# code

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

The method is used in the following code samples: VisualComponents (Win).

See also

Working with Collections