DictionaryDescriptions Object (IDictionaryDescriptions Interface)

DictionaryDescriptions object (IDictionaryDescriptions interface) in the ABBYY FineReader Engine API — Collection of DictionaryDescription objects, accessible via IBaseLanguage::DictionaryDescriptions; covers standard, user, regular-expression, and external dictionaries.

This object is a collection of dictionary descriptions (DictionaryDescription objects). It provides standard collection functionality. See Working with Collections for details.

The DictionaryDescription object can be cast to any of the StandardDictionaryDescription, UserDictionaryDescription, RegExpDictionaryDescription, and ExternalDictionaryDescription objects, which are the descriptions of different dictionary types.

The IBaseLanguage::DictionaryDescriptions property provides access to the dictionary descriptions collection. The collection of prohibiting dictionaries is accessible via the TextLanguage object.

• 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	DictionaryDescription, read-only	Provides access to a single element of the collection.

Methods

Name	Description
AddNew	Creates a new dictionary description of the specified type and adds into the collection.
DeleteAll	Removes all the elements from the collection.
DeleteAt	Removes an element from the collection.
Item	Provides access to a single element of the collection.

Related objects

Object Diagram

Samples

C# code

// The sample code assigns a user dictionary to a base language
FREngine.IEngine engine;
string dictionaryFileName = "D:\\Sample.amd";
FREngine.IBaseLanguage baseLanguage;
// Get collection of dictionary descriptions of a base language and remove all items
IDictionaryDescriptions dictionaryDescriptions = baseLanguage.DictionaryDescriptions;
dictionaryDescriptions.DeleteAll();
// Create user dictionary description and add it to the collection
IDictionaryDescription dictionaryDescription = dictionaryDescriptions.AddNew( DictionaryTypeEnum.DT_UserDictionary );
IUserDictionaryDescription userDictionaryDescription = dictionaryDescription.GetAsUserDictionaryDescription();
userDictionaryDescription.FileName = dictionaryFileName;

The object is used in the following code samples in Linux and Windows: CustomLanguage.

See also

Working with Dictionaries

DictionaryDescription

StandardDictionaryDescription

UserDictionaryDescription

RegExpDictionaryDescription

ExternalDictionaryDescription

Working with Collections

Working with Properties