TXTextControl.Proofing.TXSpell.GetHyphenationPoints Method

Returns an array of all hyphenation points for a word. Using the first implementation these points are caluclated by applying the default hyphenation list. The second implementation uses a hyphenation list of the TXSpell.HyphenationLists collection or a list from the default hyphenation lists folder that corresponds to the specified language parameter (second implementation).

Introduced: 4.0.

GetHyphenationPoints(String)

Returns an array of all hyphenation points for a word. These points are calculated by using the default hyphenation list.

[C#]
public int[] GetHyphenationPoints(string word);
[Visual Basic]
Public Function GetHyphenationPoints(ByVal word As String) As Integer()
Parameter Description
word

The word to hyphenate.

GetHyphenationPoints(String, CultureInfo)

Returns an array of all hyphenation points for a word. These points are calculated by using the hyphenation list that corresponds to the specified language parameter

[C#]
public int[] GetHyphenationPoints(string word, System.Globalization.CultureInfo language);
[Visual Basic]
Public Function GetHyphenationPoints(ByVal word As String, language As System.Globalization.CultureInfo) As Integer()
Parameter Description
word

The word to hyphenate.

language

The language, which is used to calculate the hyphenation points. If the TXSpell.HyphenationLists collection does not contain a hyphenation list, where its language does not equal exactly to the defined language parameter, the default hyphenation lists folder is examined for such a list. In case no corresponding list was found, both, first the TXSpell.HyphenationLists collection and finally the default hyphenation lists folder, are examined for a hyphenation list that equals roughly to specified language (e.g. the language parameter stands for English (USA) and the hyphenation list's language property represents English (Great Britain)).

Return Value

An array of all hyphenation points for the defined word.