Element Property

Element property in the ABBYY FineReader Engine API — common property that provides access to a single element of a FineReader Engine collection (supports the [] operator in C# on Windows).

This is a common property. Any platform-specific implementation limitations will be listed in the topics for the objects using this property.

This property provides access to a single element of ABBYY FineReader Engine collection. Each ABBYY FineReader Engine collection uses this property.

In Windows, this property allows you to access an element of the collection using the [] operator in C#.

Syntax

C++

HRESULT get_Element(
  int              Index,
  I<ElementType>** Result
);
// the "put" method is available only for some collections
HRESULT put_Element(
  int             Index,
  I<ElementType>* Value
);

C#

I<ElementType> <CollectionType>( int Index );

Visual Basic .NET

Property Element(Index As Integer) As I<ElementType>

Parameters

Index

[in] This variable contains the index of the element that is accessed via this method. It must be in the range from 0 to the Number of elements - 1, where the number of elements may be obtained from the Count property of the same collection.

Result

[out, retval] A variable of type I<ElementType>* that receives a pointer to the interface of the collection element. ElementType is the type of the object forming the collection.

Value

[in] Refers to the <ElementType> object. ElementType is the type of the object forming the collection.

Remarks

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

Collection type	Element type
AuthorsList	AuthorInfo
BarcodeText	BarcodeSymbol
BaseLanguages	BaseLanguage
BusinessCards	BusinessCard
Categories	Category
Changes	Change
CharacterRecognitionVariants	CharacterRecognitionVariant
CheckmarkGroup	CheckmarkBlock
ClassificationObjects	ClassificationObject
ClassificationResults	ClassificationResult
DetectedLanguages	DetectedLanguage
DictionaryDescriptions	DictionaryDescription
FRPages	FRPage
FuzzyStrings	FuzzyString
IntsCollection	int
LayoutBlocks	Block
Licenses	License
List	ListLevel
OfficeConverters Note: Linux and Windows only.	OfficeConverterTypeEnum
ParagraphLines	ParagraphLine
Paragraphs	Paragraph
PDFPictures	PDFPicture
PredefinedLanguages	PredefinedLanguage
RegionsCollection	Region
ScanSources Note: Windows only.	ScanSource
SeparatorGroup	SeparatorBlock
SpellReplacementCollection Note: Windows Visual Components only.	SpellReplacement
SpellWordCollection Note: Windows Visual Components only.	SpellWord
SplitRegions	SplitRegion
StringsCollection	BSTR
TableCells	TableCell
TableSeparators	TableSeparator
TabPositions	TabPosition
TrainingImagesCollection	TrainingImage
TrainingResults	TrainingResult
WordRecognitionVariants	WordRecognitionVariant
Words	Word

See also

Item

Working with Collections

Working with Properties