SpellCheckerBase.GetSuggestions(String, CultureInfo) Method

Gets suggested words to replace a specified word.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.SpellChecker.v24.2.Core.dll

Declaration

C#

public virtual SuggestionCollection GetSuggestions(
    string word,
    CultureInfo culture
)

VB.NET

Public Overridable Function GetSuggestions(
    word As String,
    culture As CultureInfo
) As SuggestionCollection

Parameters

Name	Type	Description
word	String	A string that is the word for which corrections are suggested by the spellchecker.
culture	CultureInfo	A CultureInfo object specifying the culture, ensuring that the proper dictionaries are loaded.

Returns

Type	Description
SuggestionCollection	A SuggestionCollection containing words from the dictionary that are suggested replacements.

Remarks

This method creates new suggestions for the given word, using the dictionaries for the specified culture. The suggestion list is sorted, and items with a Levenshtein distance greater than the SpellCheckerBase.LevenshteinDistance property value are excluded from the list. A new SuggestionCollection object containing the remaining suggestions is the result returned by this method.