Class DocumentSpellChecker

Inheritance
System.Object
DocumentSpellChecker
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Documents.Proofing
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class DocumentSpellChecker : ISpellChecker

Constructors

DocumentSpellChecker()

Declaration
public DocumentSpellChecker()

DocumentSpellChecker(ICustomWordDictionary)

Declaration
public DocumentSpellChecker(ICustomWordDictionary customDictionary)
Parameters
ICustomWordDictionary customDictionary

Fields

EditDistanceCoefficient

Declaration
public static readonly int EditDistanceCoefficient
Field Value
System.Int32

EditDistanceLimit

Declaration
public static readonly int EditDistanceLimit
Field Value
System.Int32

EditDistanceOneBoost

Declaration
public static readonly int EditDistanceOneBoost
Field Value
System.Int32

EditDistanceScanLimit

Declaration
public static readonly int EditDistanceScanLimit
Field Value
System.Int32

EndsDifferencePenalty

Declaration
public static readonly int EndsDifferencePenalty
Field Value
System.Int32

MaxNumberOfSuggestions

Declaration
public static readonly int MaxNumberOfSuggestions
Field Value
System.Int32

MetaphoneEqualBoost

Declaration
public static readonly int MetaphoneEqualBoost
Field Value
System.Int32

Properties

AutomaticallyLoadDefaultDictionaries

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

Declaration
public bool AutomaticallyLoadDefaultDictionaries { get; set; }
Property Value
System.Boolean

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

DictionaryList

Gets or sets the list of dictionaries used by SpellChecker. Generally this property is not intended to be used directly from your code, rather it is set automatically by MEF.

Declaration
public List<Lazy<IWordDictionary, IWordDictionaryMetadata>> DictionaryList { get; set; }
Property Value
System.Collections.Generic.List<System.Lazy<IWordDictionary, IWordDictionaryMetadata>>

Settings

Declaration
public SpellCheckerSettings Settings { get; set; }
Property Value
SpellCheckerSettings

Implements

SpellCheckingCulture

Declaration
public CultureInfo SpellCheckingCulture { get; set; }
Property Value
System.Globalization.CultureInfo

Implements

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
public void AddCustomDictionary(ICustomWordDictionary customDictionary, CultureInfo culture)
Parameters
ICustomWordDictionary customDictionary

System.Globalization.CultureInfo culture

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
public void AddDictionary(Lazy<IWordDictionary> lazyDictionary, CultureInfo culture)
Parameters
System.Lazy<IWordDictionary> lazyDictionary

System.Globalization.CultureInfo culture

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
public void AddDictionary(IWordDictionary dictionary, CultureInfo culture)
Parameters
IWordDictionary dictionary

System.Globalization.CultureInfo culture

AddWord(String)

Declaration
public void AddWord(string word)
Parameters
System.String word

Implements

AddWord(String, CultureInfo)

Declaration
public void AddWord(string word, CultureInfo culture)
Parameters
System.String word

System.Globalization.CultureInfo culture

Implements

CanAddWord()

Declaration
public bool CanAddWord()
Returns
System.Boolean

Implements

CanAddWord(CultureInfo)

Declaration
public bool CanAddWord(CultureInfo culture)
Parameters
System.Globalization.CultureInfo culture

Returns
System.Boolean

Implements

CheckWordIsCorrect(String)

Declaration
public bool CheckWordIsCorrect(string word)
Parameters
System.String word

Returns
System.Boolean

Implements

CheckWordIsCorrect(String, CultureInfo)

Declaration
public bool CheckWordIsCorrect(string word, CultureInfo culture)
Parameters
System.String word

System.Globalization.CultureInfo culture

Returns
System.Boolean

Implements

ClearDictionaries()

Clears the dictionaries used by the spellchecker. This method is used internally upon disposal of RadRichTextBox. Loaded dictionaries can be removed by using the RemoveDictionary and RemoveCustomDictionary methods.

Declaration
public void ClearDictionaries()

GetCustomDictionary()

Declaration
public ICustomWordDictionary GetCustomDictionary()
Returns
ICustomWordDictionary

Implements

GetCustomDictionary(CultureInfo)

Declaration
public ICustomWordDictionary GetCustomDictionary(CultureInfo culture)
Parameters
System.Globalization.CultureInfo culture

Returns
ICustomWordDictionary

Implements

GetDictionary()

Declaration
public IWordDictionary GetDictionary()
Returns
IWordDictionary

Implements

GetDictionary(CultureInfo)

Declaration
public IWordDictionary GetDictionary(CultureInfo culture)
Parameters
System.Globalization.CultureInfo culture

Returns
IWordDictionary

Implements

GetSuggestions(String)

Declaration
public ICollection<string> GetSuggestions(string word)
Parameters
System.String word

Returns
System.Collections.Generic.ICollection<System.String>

Implements

GetSuggestions(String, CultureInfo)

Declaration
public ICollection<string> GetSuggestions(string word, CultureInfo culture)
Parameters
System.String word

System.Globalization.CultureInfo culture

Returns
System.Collections.Generic.ICollection<System.String>

Implements

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
public bool RemoveCustomDictionary(CultureInfo culture)
Parameters
System.Globalization.CultureInfo culture

Returns
System.Boolean

RemoveCustomDictionary(ICustomWordDictionary, CultureInfo)

This method is obsolete. Use RemoveCustomDictionary(CultureInfo) instead.

Declaration
[Obsolete]
public bool RemoveCustomDictionary(ICustomWordDictionary customDictionary, CultureInfo culture)
Parameters
ICustomWordDictionary customDictionary

System.Globalization.CultureInfo culture

Returns
System.Boolean

RemoveDictionary(CultureInfo)

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

Declaration
public bool RemoveDictionary(CultureInfo culture)
Parameters
System.Globalization.CultureInfo culture

Returns
System.Boolean

RemoveWord(String)

Declaration
public void RemoveWord(string word)
Parameters
System.String word

Implements

RemoveWord(String, CultureInfo)

Declaration
public void RemoveWord(string word, CultureInfo culture)
Parameters
System.String word

System.Globalization.CultureInfo culture

Implements

Events

DataChanged

Declaration
public event EventHandler DataChanged
Event Type
System.EventHandler

Implements

Extension Methods