# SynonymList Class

> The SynonymList class represents a synonym list that gets its content from a thesaurus file. It can be used directly by the third overload of the TXSpell.CreateSynonyms method or by the first and second overload when the SynonymList is added to the TXSpell.SynonymLists collection. The implementation loads a synonym list from a thesaurus file that is defined by a synonym list path. When using the synonym list name without a file path, the corresponding thesaurus files of the default synonym lists folder are used.

- **Product:** TX Spell .NET for WPF
- **Section:** Reference
- **Kind:** Class
- **Introduced:** 7.0
- **Namespace:** `TXTextControl.Proofing`
- **Package:** `TXTextControl.TXSpell.WPF.SDK` (assembly `TXSpell.dll`, from the private NuGet feed or Text Control Offline Packages)
- **Package:** `TXTextControl.TXSpell.Core.SDK` (assembly `TXSpell.dll`, from the private NuGet feed or Text Control Offline Packages)
- **.NET Framework:** reference `TXSpell.dll` from the setup
- **Path:** TX Spell .NET for WPF > Reference > TXTextControl.Proofing > SynonymList Class
- **759 words**
- **Web URL:** https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/
- **LLMs URL:** https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/llms-full.txt

---

### Description

The SynonymList class represents a synonym list that gets its content from a thesaurus file. It can be used directly by the third overload of the [TXSpell.CreateSynonyms](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/txspell/createsynonyms-method/llms-full.txt) method or by the first and second overload when the SynonymList is added to the [TXSpell.SynonymLists](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/txspell/synonymlists-property/llms-full.txt) collection. The implementation loads a synonym list from a thesaurus file that is defined by a synonym list path. When using the synonym list name without a file path, the corresponding thesaurus files of the default synonym lists folder are used.

### Syntax

```csharp
public class SynonymList
```

```vbnet
Public Class SynonymList
```

### Examples

The following example creates a Synonym List instance and configures its display name setting for a document workflow.

```csharp
TXTextControl.Proofing.SynonymList synonymList = new("document.docx");
synonymList.DisplayName = "CustomerName";
```

```vbnet
Dim synonymList As New TXTextControl.Proofing.SynonymList("document.docx")
synonymList.DisplayName = "CustomerName"
```

---

## In This Section

- [SynonymList Constructor](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/constructor/llms-full.txt): Initializes a new instance of the SynonymList class.
- [SynonymList.DisplayName Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/displayname-property/llms-full.txt): Gets or sets the text that is displayed for the synonym list inside the options dialog. The default value is the name of the synonym list.
- [SynonymList.IsCreateSynonymsEnabled Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/iscreatesynonymsenabled-property/llms-full.txt): Gets or sets a value that indicates whether synonyms are created using this synonym list or not. The default value is true.
- [SynonymList.IsSelectedAsDefault Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/isselectedasdefault-property/llms-full.txt): Gets a value indicating whether the synonym list is selected as the default synonym list by the SynonymLanguage property. The default value is false.
- [SynonymList.Language Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/language-property/llms-full.txt): Gets or sets the SynonymList's language.
- [SynonymList.Name Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/name-property/llms-full.txt): Gets or sets the synonym list's name.

---

## Nearby

- **Previous:** [SynonymGroup.Synonyms Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymgroup/synonyms-property/llms-full.txt)
- **Next:** [SynonymList Constructor](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/constructor/llms-full.txt)