DictionaryDescription Object (IDictionaryDescription Interface)

DictionaryDescription object (IDictionaryDescription interface) in the ABBYY FineReader Engine API — Base dictionary-description object that can be cast to StandardDictionaryDescription, UserDictionaryDescription, RegExpDictionaryDescription, or ExternalDictionaryDescription.

This object is a dictionary description which may be typecast to one of its child objects: StandardDictionaryDescription, UserDictionaryDescription, RegExpDictionaryDescription, or ExternalDictionaryDescription. These objects provide access to descriptions of four different dictionary types and inherit all the properties of the DictionaryDescription object. They are also elements of the DictionaryDescriptions collection.

Properties

Name	Type	Description
Application	Engine, read-only	Returns the Engine object.
Type	DictionaryTypeEnum, read-only	Returns the type of the dictionary.
Weight	int	Stores the dictionary weight in percentage points. This value must be non-negative. By default, this property is set to 100%.

Methods

Name	Description
GetAsExternalDictionaryDescription	Returns the dictionary description as the ExternalDictionaryDescription object. If the dictionary description is not an external dictionary description, NULL is returned.
GetAsRegExpDictionaryDescription	Returns the dictionary description as the RegExpDictionaryDescription object. If the dictionary description is not a regular-expression-based dictionary description, NULL is returned.
GetAsStandardDictionaryDescription	Returns the dictionary description as the StandardDictionaryDescription object. If the dictionary description is not a standard dictionary description, NULL is returned.
GetAsUserDictionaryDescription	Returns the dictionary description as the UserDictionaryDescription object. If the dictionary description is not a user dictionary description, NULL is returned.

Related objects

Object Diagram

Output parameter

This object is the output parameter of the Item method of the DictionaryDescriptions object.

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

DictionaryDescriptions

StandardDictionaryDescription

UserDictionaryDescription

RegExpDictionaryDescription

ExternalDictionaryDescription

Working with Properties