SpellCheckerCustomDictionary Class

Represents a custom dictionary of the spell checker.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.SpellChecker.v18.1.Core.dll

Declaration

C#

public class SpellCheckerCustomDictionary :
    SpellCheckerDictionary

VB.NET

Public Class SpellCheckerCustomDictionary
    Inherits SpellCheckerDictionary

Related API Members

The following members accept/return SpellCheckerCustomDictionary objects:

Library	Related API Members
Cross-Platform Class Library	DictionaryHelper.GetCustomDictionary()
ASP.NET Web Forms Controls	ASPxSpellChecker.GetCustomDictionary()
	ASPxSpellCheckerCustomDictionary.Dictionary

Remarks

The custom dictionary can be created and updated by the user. The spelling form provides a command button for appending a word not found in dictionaries to the custom dictionary.

The custom dictionary can be saved to a file and loaded when necessary.

Example

The following code demonstrates how to create the SpellCheckerCustomDictionary dictionary at runtime.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/spellchecker-an-example-of-use-e3372

Form1.cs

using DevExpress.XtraSpellChecker;
using System;
using System.Globalization;
            SpellCheckerCustomDictionary customDictionary = new SpellCheckerCustomDictionary();
            customDictionary.AlphabetPath = @"Dictionaries\EnglishAlphabet.txt";
            customDictionary.DictionaryPath = @"Dictionaries\CustomEnglish.dic";
            customDictionary.Culture = CultureInfo.InvariantCulture;
            spellChecker1.Dictionaries.Add(customDictionary);

Form1.vb

Imports DevExpress.XtraSpellChecker
Imports System
Imports System.Globalization
            Dim customDictionary As New SpellCheckerCustomDictionary()
            customDictionary.AlphabetPath = "Dictionaries\EnglishAlphabet.txt"
            customDictionary.DictionaryPath = "Dictionaries\CustomEnglish.dic"
            customDictionary.Culture = CultureInfo.InvariantCulture
            spellChecker1.Dictionaries.Add(customDictionary)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SpellCheckerCustomDictionary class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

dxrichedit-for-wpf-how-to-configure-spell-check-in-the-richeditcontrol-e2918/CS/DXRichEdit_SpellCheck/MainWindow.xaml.cs#L109

CultureInfo cInfo = new CultureInfo(_culture);
SpellCheckerCustomDictionary custom_dict = new SpellCheckerCustomDictionary(String.Format("{0}\\{1}-custom.dic", path, _culture), cInfo);
custom_dict.Encoding = System.Text.Encoding.GetEncoding(cInfo.TextInfo.ANSICodePage);

how-to-create-a-custom-control-with-built-in-spell-checking-capabilities-e1407/CS/CustomMemoEditControl/MyMemoEdit.cs#L30

sharedDictionaryStorage.Dictionaries.Add(dictionary);
SpellCheckerCustomDictionary customDictionary = new SpellCheckerCustomDictionary("custom_US.dic", usCulture);
sharedDictionaryStorage.Dictionaries.Add(customDictionary);

how-to-check-spelling-within-the-rich-edit-control-e2640/CS/RichEditSpellChecker_Example/MainWindow.xaml.cs#L39

SpellCheckerCustomDictionary customDictionary = new SpellCheckerCustomDictionary();
customDictionary.AlphabetPath = @"Dictionaries\EnglishAlphabet.txt";

how-to-load-a-user-specific-dictionary-and-update-it-during-spelling-check-e3002/CS/SpellCheckerCustomDictionarySample/Default.aspx.cs#L29

ASPxSpellChecker checker = sender as ASPxSpellChecker;
SpellCheckerCustomDictionary dic = checker.GetCustomDictionary();
if (dic != null) {

aspxspellchecker-getting-started-e2431/CS/WebApplication1/Default.aspx.cs#L26

public class MyCustomDictionary : SpellCheckerCustomDictionary {
    public MyCustomDictionary() : base() { }

VB.NET

dxrichedit-for-wpf-how-to-configure-spell-check-in-the-richeditcontrol-e2918/VB/DXRichEdit_SpellCheck/MainWindow.xaml.vb#L105

Dim cInfo As New CultureInfo(_culture)
Dim custom_dict As New SpellCheckerCustomDictionary(String.Format("{0}\{1}-custom.dic", path, _culture), cInfo)
custom_dict.Encoding = System.Text.Encoding.GetEncoding(cInfo.TextInfo.ANSICodePage)

how-to-create-a-custom-control-with-built-in-spell-checking-capabilities-e1407/VB/CustomMemoEditControl/MyMemoEdit.vb#L32

sharedDictionaryStorage.Dictionaries.Add(dictionary)
Dim customDictionary As New SpellCheckerCustomDictionary("custom_US.dic", usCulture)
sharedDictionaryStorage.Dictionaries.Add(customDictionary)

how-to-check-spelling-within-the-rich-edit-control-e2640/VB/RichEditSpellChecker_Example/MainWindow.xaml.vb#L38

Dim customDictionary As New SpellCheckerCustomDictionary()
customDictionary.AlphabetPath = "Dictionaries\EnglishAlphabet.txt"

how-to-load-a-user-specific-dictionary-and-update-it-during-spelling-check-e3002/VB/SpellCheckerCustomDictionarySample/Default.aspx.vb#L32

Dim checker As ASPxSpellChecker = TryCast(sender, ASPxSpellChecker)
Dim dic As SpellCheckerCustomDictionary = checker.GetCustomDictionary()
If dic IsNot Nothing Then

aspxspellchecker-getting-started-e2431/VB/WebApplication1/Default.aspx.vb#L31

Public Class MyCustomDictionary
    Inherits SpellCheckerCustomDictionary

Implements

ISpellCheckerDictionary

Inheritance

Object

DictionaryBase

SpellCheckerDictionaryBase

SpellCheckerDictionary

SpellCheckerCustomDictionary