SuggestionBase Class

An instance of this class combines the suggested word and the distance between the suggested and the misspelled words.

Namespace: DevExpress.XtraSpellChecker

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

Declaration

C#

public class SuggestionBase :
    IComparable,
    IComparable<SuggestionBase>

VB.NET

Public Class SuggestionBase
    Implements IComparable,
               IComparable(Of SuggestionBase)

Related API Members

The following members accept/return SuggestionBase objects:

• SuggestionCollection.Item[Int32]

Remarks

Use the SuggestionBase.Suggestion property to get a suggested word. The distance between words is available via the SuggestionBase.Distance property and characterizes the proximity of words, also known as the Levenshtein distance.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SuggestionBase class.

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#L71

for (int i = lastIndex; i >= 0; i--) {
    SuggestionBase suggestion = suggestions[i];
    SuggestionMenuItem item =

how-to-display-spellchecker-context-menu-for-standard-text-controls-textbox-and-richtextbox-t236002/CS/SpellCheckerMenuExample/Form1.cs#L74

    System.Text.RegularExpressions.Regex rgx = new System.Text.RegularExpressions.Regex(pattern);
    if (rgx.IsMatch(e.Word)) e.Suggestions.Insert(0, new SuggestionBase("DevExpress", 0));
}

VB.NET

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

For i As Integer = lastIndex To 0 Step -1
   Dim suggestion As SuggestionBase = suggestions(i)
   Dim item As New SuggestionMenuItem(Me.richEditControl1.Document, suggestion.Suggestion, range)

how-to-display-spellchecker-context-menu-for-standard-text-controls-textbox-and-richtextbox-t236002/VB/SpellCheckerMenuExample/Form1.vb#L67

If rgx.IsMatch(e.Word) Then
    e.Suggestions.Insert(0, New SuggestionBase("DevExpress", 0))
End If

Inheritance

Object

SuggestionBase