SpellCheckerISpellDictionary Class

Represents an XtraSpellChecker dictionary originated from a dictionary in the ISpell format.

Namespace: DevExpress.XtraSpellChecker

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

Declaration

C#

public class SpellCheckerISpellDictionary :
    SpellCheckerDictionaryBase

VB.NET

Public Class SpellCheckerISpellDictionary
    Inherits SpellCheckerDictionaryBase

Related API Members

The following members accept/return SpellCheckerISpellDictionary objects:

• ASPxSpellCheckerISpellDictionary.Dictionary

Remarks

The SpellCheckerISpellDictionary instance is created by decompressing the base file, specified by the DictionaryBase.DictionaryPath property with the help of the affix file located at the SpellCheckerISpellDictionary.GrammarPath file path. Base files and affix files are a part of the non-commercial GNU ISpell project.

Note

Currently, you should use ISpell dictionaries only in the plain text format - one word per line, rather than hashed (i.e. not processed with the buildhash utility). Search for them on this page.

Example

The following code demonstrates how to create the SpellCheckerISpellDictionary 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;
            spellChecker1.Dictionaries.Clear();

            SpellCheckerISpellDictionary ispellDictionaryEnglish = new SpellCheckerISpellDictionary();
            ispellDictionaryEnglish.DictionaryPath = @"Dictionaries\ISpell\en_US\american.xlg";
            ispellDictionaryEnglish.GrammarPath = @"Dictionaries\ISpell\en_US\english.aff";
            ispellDictionaryEnglish.AlphabetPath = @"Dictionaries\EnglishAlphabet.txt";
            ispellDictionaryEnglish.Culture = new CultureInfo("en-US");
            ispellDictionaryEnglish.Load();
            spellChecker1.Dictionaries.Add(ispellDictionaryEnglish);

Form1.vb

Imports DevExpress.XtraSpellChecker
Imports System
Imports System.Globalization
            spellChecker1.Dictionaries.Clear()

            Dim ispellDictionaryEnglish As New SpellCheckerISpellDictionary()
            ispellDictionaryEnglish.DictionaryPath = "Dictionaries\ISpell\en_US\american.xlg"
            ispellDictionaryEnglish.GrammarPath = "Dictionaries\ISpell\en_US\english.aff"
            ispellDictionaryEnglish.AlphabetPath = "Dictionaries\EnglishAlphabet.txt"
            ispellDictionaryEnglish.Culture = New CultureInfo("en-US")
            ispellDictionaryEnglish.Load()
            spellChecker1.Dictionaries.Add(ispellDictionaryEnglish)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SpellCheckerISpellDictionary 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#

dxspellcheker-how-to-load-dictionaries-t471320/CS/SpellingDictionaryExample/MainWindow.xaml.cs#L88

SpellCheckerISpellDictionary ispellDictionaryEnglish = new SpellCheckerISpellDictionary();
ispellDictionaryEnglish.LoadFromStream(dict_en_US, grammar_en_US, alphabet_en_US);

spellchecker-an-example-of-use-e3372/CS/Form1.cs#L57

SpellCheckerISpellDictionary ispellDictionaryEnglish = new SpellCheckerISpellDictionary();
ispellDictionaryEnglish.DictionaryPath = @"Dictionaries\ISpell\en_US\american.xlg";

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/CS/RichEditPopupMenu/Form1.cs#L111

CultureInfo usCulture = new CultureInfo("en-US");
SpellCheckerISpellDictionary dictionary1 = new SpellCheckerISpellDictionary(@"..\..\american.xlg", @"..\..\english.aff", usCulture);
dictionary1.AlphabetPath = @"..\..\EnglishAlphabet.txt";

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

{
     SpellCheckerISpellDictionary dic = new SpellCheckerISpellDictionary();
    dic.DictionaryLoaded += new EventHandler(dic_DictionaryLoaded);

VB.NET

dxspellcheker-how-to-load-dictionaries-t471320/VB/SpellingDictionaryExample/MainWindow.xaml.vb#L87

Dim ispellDictionaryEnglish As New SpellCheckerISpellDictionary()
ispellDictionaryEnglish.LoadFromStream(dict_en_US, grammar_en_US, alphabet_en_US)

spellchecker-an-example-of-use-e3372/VB/Form1.vb#L56

Dim ispellDictionaryEnglish As New SpellCheckerISpellDictionary()
ispellDictionaryEnglish.DictionaryPath = "Dictionaries\ISpell\en_US\american.xlg"

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/VB/RichEditPopupMenu/Form1.vb#L113

Dim usCulture As New CultureInfo("en-US")
Dim dictionary1 As New SpellCheckerISpellDictionary("..\..\american.xlg", "..\..\english.aff", usCulture)
dictionary1.AlphabetPath = "..\..\EnglishAlphabet.txt"

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

Private Shared Function GetDefaultDictionary(ByVal path As String) As SpellCheckerDictionaryBase
     Dim dic As New SpellCheckerISpellDictionary()
    AddHandler dic.DictionaryLoaded, AddressOf dic_DictionaryLoaded

Implements

ISpellCheckerDictionary

Inheritance

Object

DictionaryBase

SpellCheckerDictionaryBase

SpellCheckerISpellDictionary

SpellCheckerOpenOfficeDictionary