SpellCheck.GetCustomDictionaries(TextBoxBase) Method

Reference

Definition

Namespace:: System.Windows.Controls

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the collection of lexicon file locations that are used for custom spelling checkers on a specified text-editing control.

public:
 static System::Collections::IList ^ GetCustomDictionaries(System::Windows::Controls::Primitives::TextBoxBase ^ textBoxBase);

public static System.Collections.IList GetCustomDictionaries (System.Windows.Controls.Primitives.TextBoxBase textBoxBase);

static member GetCustomDictionaries : System.Windows.Controls.Primitives.TextBoxBase -> System.Collections.IList

Public Shared Function GetCustomDictionaries (textBoxBase As TextBoxBase) As IList

Parameters

textBoxBase: TextBoxBase

The text-editing control whose collection of lexicon files is retrieved.

Returns

IList

The collection of lexicon file locations.

Exceptions

ArgumentNullException

The textBoxBase is null.

Remarks

Custom dictionaries use lexicon files, which are simple text files that have a .lex extension. Each line of a lexicon file contains a single word that is accepted as a legitimate spelling. The first line of the file can specify a locale identifier (LCID) that the dictionary applies to. If the locale is not specified, the dictionary applies to all languages. For more information, see Locale IDs. The following example shows the first few lines of a lexicon file for the English language.

#LID 1033  
TextBlock  
TextBox  
ListBox

To specify one or more custom dictionaries for a TextBox or any class that derives from TextBoxBase, specify the location of the lexicon file by adding the URI for the file to the IList returned by the GetCustomDictionaries method.

To enable the spelling checker, set the SpellCheck.IsEnabled property to true on a TextBox or on any class that derives from TextBoxBase. All custom dictionaries for that TextBox are used in addition to the default spelling checker. For more information about the spelling checker, see SpellCheck.

Applies to

Jaa