Class
DocumentSpellChecker

Definition

Namespace:Telerik.WinForms.Documents.Proofing

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

cs-api-definition
public class DocumentSpellChecker : ISpellChecker

Inheritance: objectDocumentSpellChecker

Implements: ISpellChecker

Constructors

DocumentSpellChecker()

Declaration

cs-api-definition
public DocumentSpellChecker()

DocumentSpellChecker(ICustomWordDictionary)

Declaration

cs-api-definition
public DocumentSpellChecker(ICustomWordDictionary customDictionary)

Parameters

customDictionary

ICustomWordDictionary

Fields

EditDistanceCoefficient

Declaration

cs-api-definition
public static readonly int EditDistanceCoefficient

Field Value

int

EditDistanceLimit

Declaration

cs-api-definition
public static readonly int EditDistanceLimit

Field Value

int

EditDistanceOneBoost

Declaration

cs-api-definition
public static readonly int EditDistanceOneBoost

Field Value

int

EditDistanceScanLimit

Declaration

cs-api-definition
public static readonly int EditDistanceScanLimit

Field Value

int

EndsDifferencePenalty

Declaration

cs-api-definition
public static readonly int EndsDifferencePenalty

Field Value

int

MaxNumberOfSuggestions

Declaration

cs-api-definition
public static readonly int MaxNumberOfSuggestions

Field Value

int

MetaphoneEqualBoost

Declaration

cs-api-definition
public static readonly int MetaphoneEqualBoost

Field Value

int

Properties

AutomaticallyLoadDefaultDictionaries

Gets or sets a value indicating whether MEF should be used to load default dictionaries.

Declaration

cs-api-definition
public bool AutomaticallyLoadDefaultDictionaries { get; set; }

Property Value

bool

true if default dictionaries should be loaded automatically; otherwise, false.

Settings

Declaration

cs-api-definition
public SpellCheckerSettings Settings { get; set; }

Property Value

SpellCheckerSettings

Implements ISpellChecker.Settings

SpellCheckingCulture

Declaration

cs-api-definition
public CultureInfo SpellCheckingCulture { get; set; }

Property Value

CultureInfo

Implements ISpellChecker.SpellCheckingCulture

Methods

AddCustomDictionary(ICustomWordDictionary, CultureInfo)

Adds a custom dictionary with the specified culture to the spell checker. If a dictionary with this culture already exists, it is overwritten.

Declaration

cs-api-definition
public void AddCustomDictionary(ICustomWordDictionary customDictionary, CultureInfo culture)

Parameters

customDictionary

ICustomWordDictionary

culture

CultureInfo

AddDictionary(IWordDictionary, CultureInfo)

Adds a dictionary with the specified culture to the spell checker. If a dictionary with this culture already exists, it is overwritten.

Declaration

cs-api-definition
public void AddDictionary(IWordDictionary dictionary, CultureInfo culture)

Parameters

dictionary

IWordDictionary

culture

CultureInfo

AddDictionary(Lazy<IWordDictionary>, CultureInfo)

Adds a lazily initialized dictionary with the specified culture to the spell checker. If a dictionary with this culture already exists, it is overwritten.

Declaration

cs-api-definition
public void AddDictionary(Lazy<IWordDictionary> lazyDictionary, CultureInfo culture)

Parameters

lazyDictionary

Lazy<IWordDictionary>

culture

CultureInfo

AddWord(string)

Declaration

cs-api-definition
public void AddWord(string word)

Parameters

word

string

Implements ISpellChecker.AddWord(string)

AddWord(string, CultureInfo)

Declaration

cs-api-definition
public void AddWord(string word, CultureInfo culture)

Parameters

word

string

culture

CultureInfo

Implements ISpellChecker.AddWord(string, CultureInfo)

CanAddWord()

Declaration

cs-api-definition
public bool CanAddWord()

Returns

bool

Implements ISpellChecker.CanAddWord()

CanAddWord(CultureInfo)

Declaration

cs-api-definition
public bool CanAddWord(CultureInfo culture)

Parameters

culture

CultureInfo

Returns

bool

Implements ISpellChecker.CanAddWord(CultureInfo)

CheckWordIsCorrect(string)

Declaration

cs-api-definition
public bool CheckWordIsCorrect(string word)

Parameters

word

string

Returns

bool

Implements ISpellChecker.CheckWordIsCorrect(string)

CheckWordIsCorrect(string, CultureInfo)

Declaration

cs-api-definition
public bool CheckWordIsCorrect(string word, CultureInfo culture)

Parameters

word

string

culture

CultureInfo

Returns

bool

Implements ISpellChecker.CheckWordIsCorrect(string, CultureInfo)

GetCustomDictionary()

Declaration

cs-api-definition
public ICustomWordDictionary GetCustomDictionary()

Returns

ICustomWordDictionary

Implements ISpellChecker.GetCustomDictionary()

GetCustomDictionary(CultureInfo)

Declaration

cs-api-definition
public ICustomWordDictionary GetCustomDictionary(CultureInfo culture)

Parameters

culture

CultureInfo

Returns

ICustomWordDictionary

Implements ISpellChecker.GetCustomDictionary(CultureInfo)

GetDictionary()

Declaration

cs-api-definition
public IWordDictionary GetDictionary()

Returns

IWordDictionary

Implements ISpellChecker.GetDictionary()

GetDictionary(CultureInfo)

Declaration

cs-api-definition
public IWordDictionary GetDictionary(CultureInfo culture)

Parameters

culture

CultureInfo

Returns

IWordDictionary

Implements ISpellChecker.GetDictionary(CultureInfo)

GetSuggestions(string)

Declaration

cs-api-definition
public ICollection<string> GetSuggestions(string word)

Parameters

word

string

Returns

ICollection<string>

Implements ISpellChecker.GetSuggestions(string)

GetSuggestions(string, CultureInfo)

Declaration

cs-api-definition
public ICollection<string> GetSuggestions(string word, CultureInfo culture)

Parameters

word

string

culture

CultureInfo

Returns

ICollection<string>

Implements ISpellChecker.GetSuggestions(string, CultureInfo)

RemoveCustomDictionary(CultureInfo)

Removes the custom dictionary with the specified culture from the spell checker. This method returns false if no such dictionary is found.

Declaration

cs-api-definition
public bool RemoveCustomDictionary(CultureInfo culture)

Parameters

culture

CultureInfo

Returns

bool

RemoveDictionary(CultureInfo)

Removes the dictionary with the specified culture from the spell checker. This method returns false if no such dictionary is found.

Declaration

cs-api-definition
public bool RemoveDictionary(CultureInfo culture)

Parameters

culture

CultureInfo

Returns

bool

RemoveWord(string)

Declaration

cs-api-definition
public void RemoveWord(string word)

Parameters

word

string

Implements ISpellChecker.RemoveWord(string)

RemoveWord(string, CultureInfo)

Declaration

cs-api-definition
public void RemoveWord(string word, CultureInfo culture)

Parameters

word

string

culture

CultureInfo

Implements ISpellChecker.RemoveWord(string, CultureInfo)

Events

DataChanged

Declaration

cs-api-definition
public event EventHandler DataChanged

Event Value

EventHandler

Implements ISpellChecker.DataChanged