UserDictionaryDescription Object (IUserDictionaryDescription Interface)

UserDictionaryDescription object (IUserDictionaryDescription interface) in the ABBYY FineReader Engine API — Provides access to a user dictionary; derived from IDictionaryDescription and exposing a FileName property pointing to the user-dictionary file.

This object provides access to a user dictionary. The IUserDictionaryDescription interface is derived from the IDictionaryDescription interface and inherits all its properties.

A user dictionary can be created by the user with the help of the Dictionary object. The path to the created dictionary is specified in the FileName property of the UserDictionaryDescription object. Then the configured object is added to the collection of dictionary descriptions of a language.

Properties

Name	Type	Description
FileName	BSTR	The path to the user dictionary file. This property does not check the validity of the dictionary, which will be done later when the dictionary is used.

Related objects

Object Diagram

Output parameter

This object is the output parameter of the Item, AddNew methods of the DictionaryDescriptions object.

Samples

C# code

FREngine.IFRDocument frdoc;
FREngine.IBaseLanguage baseLanguage;
string dictionaryFileName = "D:\\sample.amd";
// We presume that a user dictionary has already been created
// Assigning a user dictionary to a base language
// Get the collection of dictionary descriptions and remove all items
IDictionaryDescriptions dictionaryDescriptions = baseLanguage.DictionaryDescriptions;
dictionaryDescriptions.DeleteAll();
// Create a 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 for Linux and Windows: CustomLanguage

See also

Working with Dictionaries

Dictionary

DictionaryDescription

DictionaryDescriptions

Working with Properties