SuggestionCollection Class

A collection of suggestions prepared for a misspelled word.

Namespace: DevExpress.XtraSpellChecker

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

Declaration

C#

public class SuggestionCollection :
    IEnumerable<SuggestionBase>,
    IEnumerable

VB.NET

Public Class SuggestionCollection
    Implements IEnumerable(Of SuggestionBase),
               IEnumerable

Related API Members

The following members accept/return SuggestionCollection objects:

• NotInDictionaryWordFoundEventArgs.Suggestions
• PrepareSuggestionsEventArgs.Suggestions
• SpellCheckerBase.GetSuggestions(String)
• SpellCheckerBase.GetSuggestions(String, CultureInfo)

Remarks

The collection consists of SuggestionBase class objects that combine the suggested word and the distance between the suggested and misspelled words.

To get access to the collection of suggestions prepared for a word which is not found in the dictionary, use the PrepareSuggestionsEventArgs.Suggestions property.

To limit the number of suggestions shown in As-You-Type context menu for the XtraSpellChecker, specify the CheckAsYouTypeOptions.SuggestionCount property value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SuggestionCollection 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#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

Inheritance

Object

SuggestionCollection