Interface
ISpellChecker

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

Definition

Namespace:Telerik.Windows.Documents.Proofing

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public interface ISpellChecker

Properties

Settings

Represents the settings for the spell checker.

Declaration

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

Property Value

SpellCheckerSettings

SpellCheckingCulture

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

Declaration

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

Property Value

CultureInfo

A 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

cs-api-definition
void AddWord(string word)

Parameters

word

string

The word to be added to the dictionary.

AddWord(string, CultureInfo)

Adds a word to the spell check dictionary.

Declaration

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

Parameters

word

string

The word to add to the dictionary.

culture

CultureInfo

The culture information that specifies the linguistic rules to apply.

CanAddWord()

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

Declaration

cs-api-definition
bool CanAddWord()

Returns

bool

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

cs-api-definition
bool CanAddWord(CultureInfo culture)

Parameters

culture

CultureInfo

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

Returns

bool

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

CheckWordIsCorrect(string)

Checks whether the specified word is correctly spelled.

Declaration

cs-api-definition
bool CheckWordIsCorrect(string word)

Parameters

word

string

The word to be checked for spelling correctness.

Returns

bool

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

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

Parameters

word

string

The word to be checked for correctness.

culture

CultureInfo

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

Returns

bool

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

GetCustomDictionary()

Retrieves the custom dictionary used by the spell checker.

Declaration

cs-api-definition
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

cs-api-definition
ICustomWordDictionary GetCustomDictionary(CultureInfo culture)

Parameters

culture

CultureInfo

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

cs-api-definition
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

cs-api-definition
IWordDictionary GetDictionary(CultureInfo culture)

Parameters

culture

CultureInfo

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

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

Parameters

word

string

The misspelled word for which suggestions are being requested.

Returns

ICollection<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

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

Parameters

word

string

The word for which suggestions are to be retrieved.

culture

CultureInfo

The culture information that dictates the language and rules to be applied while generating suggestions.

Returns

ICollection<string>

A collection of suggestions for the specified word.

RemoveWord(string)

Removes a specified word from the spell check dictionary.

Declaration

cs-api-definition
void RemoveWord(string word)

Parameters

word

string

The word to be removed from the dictionary.

RemoveWord(string, CultureInfo)

Removes a specified word from the spell checker dictionary.

Declaration

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

Parameters

word

string

The word to be removed from the dictionary.

culture

CultureInfo

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

Events

DataChanged

Declaration

cs-api-definition
event EventHandler DataChanged

Event Value

EventHandler