TXTextControl.Proofing.TXSpell.GetHyphenationPoint Method

Returns the next hyphenation point for a specific word right before a defined divide position. Using the first implementation that point is 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). If there is no hyphenation point before that divide position and the position is less the word length, the method returns 0. For divide positions greater than or equal to the number of word characters, the method returns the word length.

Introduced: 4.0.

public int GetHyphenationPoint(string word, int dividePosition);

Public Function GetHyphenationPoint(ByVal word As String, ByVal dividePosition As Integer) As Integer

GetHyphenationPoint(String, Int, System.Globalization.CultureInfo)

C#
VB.NET

public int GetHyphenationPoint(string word, int dividePosition, System.Globalization.CultureInfo language);

Public Function GetHyphenationPoint(ByVal word As String, ByVal dividePosition As Integer, language As System.Globalization.CultureInfo) As Integer

Parameters

Parameter	Description
word	The word to hyphenate.
dividePosition	The defined divide position.
language	The language, which is used to calculate the hyphenation point. 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

The next hyphenation point right before the defined divide position.

GetHyphenationPoint Method

TXSpell Class

TXTextControl.Proofing Namespace

GetHyphenationPoint(String, Int)

GetHyphenationPoint(String, Int, System.Globalization.CultureInfo)

Parameters

Return Value

GetHyphenationPoint Method

TXSpell Class​

TXTextControl.Proofing Namespace​

GetHyphenationPoint(String, Int)

GetHyphenationPoint(String, Int, System.Globalization.CultureInfo)

Parameters

Return Value

TXSpell Class

TXTextControl.Proofing Namespace