TXSpellChecker.HyphenationLanguage Property — TX Spell .NET for Windows Forms

Description

Gets or sets the name of a hyphenation list that is located at the default hyphenation lists folder. When using the HyphenationLanguage property, the Hyphenation.IsSelectedAsDefault property of the chosen hyphenation list is set to true. The default value is "(Auto)".

Syntax

public string HyphenationLanguage { get; set; }

Public Property HyphenationLanguage As String

Members

Value	Description
"hyph__.dic"	The corresponding hyphenation list is added to the TXSpell.HyphenationLists collection (e.g. "hyph_en_US.dic" for the US English hyphenation list).
"(Auto)"	That hyphenation list is added to the TXSpell.HyphenationLists collection that equals to the language of the default spell check dictionary. If the default hyphenation lists folder does not contain such a hyphenation list, a list is chosen that corresponds roughly to the dictionary's language (e.g. the default dictionary is "en_GB", but the default hyphenation lists folder only contains a "hyph_en_US.dic" and a "hyph_de_DE.dic" hyphenation list. In this case, the "hyph_en_US.dic" hyphenation list is chosen.). In case that no default spell check dictionary is selected (TXSpell.Language is set to "(none)"), a hyphenation list is chosen that equals or roughly equals to the language of the application environment.
"(none)"	No hyphenation list is set.

Examples

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

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

tXSpellChecker.HyphenationLanguage = "Quarterly report"
If Not String.IsNullOrWhiteSpace(tXSpellChecker.HyphenationLanguage) Then
    Console.WriteLine($"Hyphenation Language: {tXSpellChecker.HyphenationLanguage}")
End If

Remarks

The property is reset to "(none)", if there is no corresponding hyphenation list in the default hyphenation lists folder that corresponds to the language of the default dictionary's language or the language of the application environment.