TX Spell .NET for WPF

SynonymListCollection Class

Class|Introduced in 7.0
Namespace
TXTextControl.Proofing
Package
TXTextControl.TXSpell.WPF.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXSpell.dll
Install
dotnet add package TXTextControl.TXSpell.WPF.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. SynonymListCollection
Implements
IEnumerable

Description

An instance of the SynonymListCollection class contains all objects of type SynonymList that will be used by the first and second overload of the TXSpell.CreateSynonyms method. 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, please see the .NET Framework reference.

Syntax

public class SynonymListCollection : CollectionBase, IEnumerable

Examples

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

Console.WriteLine($"Current: {synonymListCollection.Current}");
Console.WriteLine("Synonym List Collection is ready for use.");

Members

Properties

PropertyDescription
CurrentNot described in the reference. public object Current { get; }
ItemGets an object of type SynonymList from the collection. This property is the indexer for the SynonymListCollection class.

Methods

MethodDescription
AddAdds objects of type SynonymList to the collection.
GetItemGets a particular SynonymList from the collection by using the specified name.
RemoveRemoves objects of type SynonymList from the collection.
RemoveAtNot described in the reference. public void RemoveAt(int index);