UserDictionary Class

Description

The UserDictionary class represents a dictionary that allows to use, create and edit user dictionaries. The first constructor creates an empty UserDictionary object with no reference to a file. The second constructor initializes a new UserDictionary object that is filled with the content of a specified word list file. As with all dictionaries of type Dictionary, the content of the dictionary is only accessed when the dictionary was added to the TXSpell.Dictionaries collection. The third constructor loads a dictionary from string arrays that represent the content of an user dictionary. It is recommended to create that array by using the encoding that was used to create the source of that dictionary. Using that implementation, it is required to define the language of the dictionary through the System.Globalization.CultureInfo language parameter that sets the user dictionary's Language property automatically. To declare a specific encoding for the dictionary, use the Dictionary.DictionaryEncoding property. If the encoding is not declared through the property or inside the word list file, the encoding of operation system's current ANSI code page is used. The UserDictionary class is inherited from the abstract class Dictionary.

Syntax

public sealed class UserDictionary : Dictionary

Public NotInheritable Class UserDictionary
    Inherits Dictionary

Examples

The following example creates an User Dictionary instance and configures its is editable setting for a document workflow.

TXTextControl.Proofing.UserDictionary userDictionary = new();
userDictionary.IsEditable = true;

Dim userDictionary As New TXTextControl.Proofing.UserDictionary()
userDictionary.IsEditable = True

Members

Constructors

Properties

Methods

Further Reading

• Loading Dictionaries Dynamically in TX Spell .NET – December 20, 2013
• Spell Checking, MailMerge and UserDictionaries – November 19, 2012