TXTextControl.Proofing.HyphenationList Class

The HyphenationList class represents a list of hyphenation rules that gets its content from a Hunspell Open Source hyphenation dictionary. As with all objects of type HyphenationList the content of that list is only accessed when the dictionary is added to the TXSpell.HyphenationLists collection. The first implementation loads a Hunspell Open Source hyphenation dictionary from a file that is defined by a dictionary path. Using the dictionary name only without a file path, the corresponding dictionary file of the default hyphenation list folder is used. The second constructor loads a hyphenation dictionary from string arrays that represent the content of a Hunspell Open Source hyphenation dictionary. It is recommended to create these arrays by using the encoding that is defined in the corresponding file represented by the encoding string in the first line. Using this implementation, it is also required to define the language of the dictionary by setting the System.Globalization.CultureInfo language parameter that sets the Proofing.HyphenationList.Language property automatically.

Introduced: 4.0.

Syntax

[C#]
public sealed class HyphenationList
[Visual Basic]
Public NotInheritable Class HyphenationList

Constructors

Constructor Description
HyphenationList Overloaded. Initializes a new instance of the HyphenationList class.

Properties

Property Description
HyphenateCapitalizedWords Gets or sets a value indicating whether words in uppercase will be hyphenated.
IsSelectedAsDefault Gets a value indicating whether the hyphenation list is selected as the default hyphenation list by the HyphenationLanguage property.
Language Gets or sets the hyphenation list's language.
MinCharsAtWordBegin Specifies the minimum number of joined characters at the beginning of a hyphenated word.
MinCharsAtWordEnd Specifies the minimum number of joined characters at the end of a hyphenated word.
MinSyllablesAfterCompoundHyphenationPoint Specifies the minimum number of syllables behind a compound hyphenation point.
MinSyllablesBeforeCompoundHyphenationPoint Specifies the minimum number of syllables before a compound hyphenation point.
Name Gets or sets the hyphenation list's name.
UseOnlyCompoundHyphenationPoints Gets or sets a value indicating whether words will be only hyphenated at compound junctions.