HyphenationList Class

Description

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.

Syntax

public sealed class HyphenationList

Public NotInheritable Class HyphenationList

Examples

The following example creates a Hyphenation List instance and configures its min syllables after compound hyphenation point setting for a document workflow.

TXTextControl.Proofing.HyphenationList hyphenationList = new("document.docx");
hyphenationList.MinSyllablesAfterCompoundHyphenationPoint = 10;

Dim hyphenationList As New TXTextControl.Proofing.HyphenationList("document.docx")
hyphenationList.MinSyllablesAfterCompoundHyphenationPoint = 10

Members

Constructors

Properties