ISpellChecker.GetSuggestions(String, CultureInfo) Method

Constructs an ordered list of suggestions for a given word.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.Data.v23.2.dll

NuGet Package: DevExpress.Data

Declaration

C#

string[] GetSuggestions(
    string word,
    CultureInfo culture
)

VB.NET

Function GetSuggestions(
    word As String,
    culture As CultureInfo
) As String()

Parameters

Name	Type	Description
word	String	A System.String representing a word for which the suggestions should be calculated.
culture	CultureInfo	A CultureInfo object specifying the culture, ensuring that the proper dictionaries are loaded.

Returns

Type	Description
String[]	A SuggestionCollection object representing a sorted list of suggested words.

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.