Skip to main content
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

NameTypeDescription
ApplicationEngine, read-onlyReturns the Engine object.
TypeDictionaryTypeEnum, read-onlyReturns the type of the dictionary.
WeightintStores the dictionary weight in percentage points. This value must be non-negative. By default, this property is set to 100%.

​
Methods

NameDescription
GetAsExternalDictionaryDescriptionReturns the dictionary description as the ExternalDictionaryDescription object. If the dictionary description is not an external dictionary description, NULL is returned.
GetAsRegExpDictionaryDescriptionReturns the dictionary description as the RegExpDictionaryDescription object. If the dictionary description is not a regular-expression-based dictionary description, NULL is returned.
GetAsStandardDictionaryDescriptionReturns the dictionary description as the StandardDictionaryDescription object. If the dictionary description is not a standard dictionary description, NULL is returned.
GetAsUserDictionaryDescriptionReturns the dictionary description as the UserDictionaryDescription object. If the dictionary description is not a user dictionary description, NULL is returned.
DictionaryDescription Object Diagram

​
Output parameter

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

​
Samples

// 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