TX Spell .NET for Windows Forms

SynonymLanguage Property

Property|Introduced in 7.0

Namespace: TXTextControl.Proofing

Package: TXTextControl.TXSpell.WinForms.SDK as TXSpell.Windows.Forms.dll from the private NuGet feed or Text Control Offline Packages

Description

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)".

Syntax

public string SynonymLanguage { get; set; }

Public Property SynonymLanguage As String

Members

Value	Description
"__.dat" or "__.idx"	The corresponding synonym list is added to the TXSpellChecker.SynonymLists collection (e.g. "th_en_US_v2.dat" for the US English synonym list).
"(Auto)"	That synonym list is added to the TXSpellChecker.SynonymLists collection that equals to the language of the default spell check dictionary. 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 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.

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

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.