TX Spell .NET for Windows Forms

SuggestionCollection Class

Class
Namespace
TXTextControl.Proofing
Package
TXTextControl.TXSpell.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXSpell.dll
Install
dotnet add package TXTextControl.TXSpell.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXSpell.dll from the setup.
Also in
TXTextControl.TXSpell.Core.SDK as TXSpell.dll
Inherits
  1. CollectionBase
  2. SuggestionCollection
Implements
IEnumerable, IEnumerator

Description

An instance of the SuggestionCollection class contains objects of the type Suggestion. It is inherited from the abstract class System.Collections.CollectionBase and implements the System.Collections.IEnumerable and System.Collections.IEnumerator interfaces. For a list of properties, methods and events of these classes and interfaces see the .NET Framework reference. The SuggestionCollection is sorted by suggestions with the closest match.

Syntax

public sealed class SuggestionCollection : CollectionBase, IEnumerable, IEnumerator

Examples

The following example includes the current value from a Suggestion Collection object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Current: {suggestionCollection.Current}");
Console.WriteLine("Suggestion Collection is ready for use.");

Members

Properties

PropertyDescription
CurrentNot described in the reference. public object Current { get; }
ItemGets a suggestion from the collection. This property is the indexer for the SuggestionCollection class.

Methods

MethodDescription
MoveNextNot described in the reference. public bool MoveNext();
ResetNot described in the reference. public void Reset();