SpellCheckerBase.GetSuggestions(String) Method

Gets suggested words to replace a specified word.

Namespace: DevExpress.XtraSpellChecker

Assembly: DevExpress.SpellChecker.v19.1.Core.dll

Declaration

C#

public virtual SuggestionCollection GetSuggestions(
    string word
)

VB.NET

Public Overridable Function GetSuggestions(
    word As String
) As SuggestionCollection

Parameters

Name	Type	Description
word	String	A string that is the word for which corrections are suggested by the spellchecker.

Returns

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

Remarks

Use the GetSuggestions method to implement your own spelling forms or check-as-you-type techniques.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetSuggestions(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/CS/RichEditPopupMenu/Form1.cs#L66

void CreateMenuItems(RichEditPopupMenu menu, DocumentRange range, string word) {
    SuggestionCollection suggestions = this.spellChecker1.GetSuggestions(word);
    int count = suggestions.Count;

VB.NET

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/VB/RichEditPopupMenu/Form1.vb#L69

Private Sub CreateMenuItems(ByVal menu As RichEditPopupMenu, ByVal range As DocumentRange, ByVal word As String)
    Dim suggestions As SuggestionCollection = Me.spellChecker1.GetSuggestions(word)
    Dim count As Integer = suggestions.Count