Interface ISpellChecker

Represents a spell checker interface that provides methods for spell-checking text.

Namespace: Telerik.Windows.Documents.Proofing
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public interface ISpellChecker

Properties

Settings

Represents the settings for the spell checker.

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

SpellCheckingCulture

Gets or sets the culture used by the spell checker for spell checking operations.

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

A System.Globalization.CultureInfo object representing the culture that determines the language and locale to be used during spell checking.

Methods

AddWord(String)

Adds a specified word to the spell checker's dictionary.

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

The word to be added to the dictionary.

AddWord(String, CultureInfo)

Adds a word to the spell check dictionary.

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

The word to add to the dictionary.
System.Globalization.CultureInfo culture

The culture information that specifies the linguistic rules to apply.

CanAddWord()

Determines whether a word can be added to the spell checker dictionary.

Declaration
bool CanAddWord()
Returns
System.Boolean

A boolean value indicating if the word can be added. Returns true if the word can be added; otherwise, false.

CanAddWord(CultureInfo)

Determines whether a word can be added to the spell checker for the specified culture.

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

The culture information that specifies the language context for the spell checker.
Returns
System.Boolean

Returns true if the word can be added; otherwise, false.

CheckWordIsCorrect(String)

Checks whether the specified word is correctly spelled.

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

The word to be checked for spelling correctness.
Returns
System.Boolean

True if the word is spelled correctly; otherwise, false.

CheckWordIsCorrect(String, CultureInfo)

Checks if the specified word is correct according to the spelling rules defined by the spell checker.

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

The word to be checked for correctness.
System.Globalization.CultureInfo culture

The CultureInfo that specifies the language and regional settings for the spell checking.
Returns
System.Boolean

Returns true if the word is spelled correctly; otherwise, false.

GetCustomDictionary()

Retrieves the custom dictionary used by the spell checker.

Declaration
ICustomWordDictionary GetCustomDictionary()
Returns
ICustomWordDictionary

An instance of a custom dictionary, which contains user-defined words that are not found in the standard spell checking dictionary.

GetCustomDictionary(CultureInfo)

Retrieves the custom dictionary associated with the specified culture information.

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

The culture information for which to retrieve the custom dictionary.
Returns
ICustomWordDictionary

The custom dictionary for the specified culture, or null if no custom dictionary exists.

GetDictionary()

Retrieves the dictionary used by the spell checker for checking spelling and grammar.

Declaration
IWordDictionary GetDictionary()
Returns
IWordDictionary

The dictionary associated with the spell checker as an instance of the IWordDictionary interface.

GetDictionary(CultureInfo)

Retrieves the dictionary for the specified culture information.

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

The culture information for which the dictionary is to be retrieved.
Returns
IWordDictionary

A dictionary object that corresponds to the specified culture.

GetSuggestions(String)

Retrieves a list of suggested corrections for the specified misspelled word.

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

The misspelled word for which suggestions are being requested.
Returns
System.Collections.Generic.ICollection<System.String>

A list of string suggestions that provide possible corrections for the given word.

GetSuggestions(String, CultureInfo)

Retrieves a list of suggestions for a given word based on the specified culture information.

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

The word for which suggestions are to be retrieved.
System.Globalization.CultureInfo culture

The culture information that dictates the language and rules to be applied while generating suggestions.
Returns
System.Collections.Generic.ICollection<System.String>

A collection of suggestions for the specified word.

RemoveWord(String)

Removes a specified word from the spell check dictionary.

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

The word to be removed from the dictionary.

RemoveWord(String, CultureInfo)

Removes a specified word from the spell checker dictionary.

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

The word to be removed from the dictionary.
System.Globalization.CultureInfo culture

The culture information that defines the language context of the word.

Events

DataChanged

Declaration
event EventHandler DataChanged
Event Type
System.EventHandler

Extension Methods