# TXSpellChecker.SynonymLanguage Property

> Gets or sets the name of a synonym list that is located at the default synonym lists folder. When using the SynonymLanguage property, the SynonymList.IsSelectedAsDefault property of the selected synonym list is set to true. The default value is "(Auto)".

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

---

### Description

Gets or sets the name of a [synonym list](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/llms-full.txt) that is located at the default synonym lists folder. When using the SynonymLanguage property, the [SynonymList.IsSelectedAsDefault](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/isselectedasdefault-property/llms-full.txt) property of the selected [synonym list](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/llms-full.txt) is set to true. The default value is `"(Auto)"`.

### Syntax

```csharp
public string SynonymLanguage { get; set; }
```

```vbnet
Public Property SynonymLanguage As String
```

### Members

| Value | Description |
|---|---|
| "\_\_.dat" or "\_\_.idx" | The corresponding [synonym list](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/llms-full.txt) is added to the [TXSpellChecker.SynonymLists](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-wpf-proofing/txspellchecker/synonymlists-property/llms-full.txt) collection (e.g. "th\_en\_US\_v2.dat" for the US English synonym list). |
| "(Auto)" | That [synonym list](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/llms-full.txt) is added to the [TXSpellChecker.SynonymLists](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-wpf-proofing/txspellchecker/synonymlists-property/llms-full.txt) collection that equals to the [language](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/dictionary/language-property/llms-full.txt) of the [default spell check dictionary](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/dictionary/isselectedasdefault-property/llms-full.txt). If the default synonym lists folder does not contain such a synonym list, a list is selected that corresponds roughly to the dictionary's language (e.g. the default dictionary is "de\_CH", but the default synonym lists folder only contains a "th\_en\_US\_v2.dat" and a "th\_de\_DE\_v2.dat" synonym list. In this case, the "th\_de\_DE\_v2.dat" synonym list is selected.). In case no default spell check dictionary is selected (TXSpellChecker.Language is set to "(none)") or no synonym list was found that resembles the default dictionary's language, a synonym list is selected that equals or roughly equals to the language of the application environment. If no such synonym list is given, the "en\_US" synonym list or (if no "en\_US" synonym list available) the first synonym list of the default synonym lists folder is selected. The TXSpellChecker.SynonymLanguage Property is set to "(none)", if the default synonym list folder does not contain any synonym lists. |
| "(none)" | No [synonym list](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-proofing/synonymlist/llms-full.txt) is set. |

### Examples

The following example uses `TXSpellChecker.SynonymLanguage` to configure synonym language as part of the txspell checker workflow. The configured value is checked before the workflow continues.

```csharp
tXSpellChecker.SynonymLanguage = "Quarterly report";
if (!string.IsNullOrWhiteSpace(tXSpellChecker.SynonymLanguage))
{
    Console.WriteLine($"Synonym Language: {tXSpellChecker.SynonymLanguage}");
}
```

```vbnet
tXSpellChecker.SynonymLanguage = "Quarterly report"
If Not String.IsNullOrWhiteSpace(tXSpellChecker.SynonymLanguage) Then
    Console.WriteLine($"Synonym Language: {tXSpellChecker.SynonymLanguage}")
End If
```

### Remarks

The property is reset to "(Auto)", if there is no corresponding synonym list in the default synonym lists folder and to "(none)", if the directory contains no synonym list.

---

## Nearby

- **Previous:** [TXSpellChecker.Suggestions Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-wpf-proofing/txspellchecker/suggestions-property/llms-full.txt)
- **Next:** [TXSpellChecker.SynonymLists Property](https://docs.textcontrol.com/tx-spell-dotnet-wpf/reference/txtextcontrol-wpf-proofing/txspellchecker/synonymlists-property/llms-full.txt)
