TXTextControl.Proofing.TXSpellChecker.HyphenationLanguage Property

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

Introduced: 4.0.

Syntax

[C#]
public string HyphenationLanguage{ get; set; }
[Visual Basic]
Public Property HyphenationLanguage() As String
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. If no such hyphenation list is given, the first hyphenation list of the default hyphenation lists folder is chosen.
"(none)" No hyphenation list is set.

Remarks

An exception is thrown, if there is no corresponding hyphenation list inside the default hyphenation lists folder.