HyphenateWordEventArgs Class
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.dll
- Inherits
- Event
Args - Hyphenate
Word Event Args
- Event
Description
The HyphenateWordEventArgs class provides data for the TextControl.HyphenateWord, ServerTextControl.HyphenateWord and WPF.TextControl.HyphenateWord events.
Syntax
public class HyphenateWordEventArgs : EventArgsPublic Class HyphenateWordEventArgs
Inherits EventArgsExamples
The following example uses HyphenateWordEventArgs.DividePos while handling HyphenateWord.
textControl.HyphenateWord += (_, e) =>
{
Console.WriteLine($"Divide Pos: {e.DividePos}");
};AddHandler textControl.HyphenateWord,
Sub(sender, e)
Console.WriteLine($"Divide Pos: {e.DividePos}")
End SubMembers
Properties
| Property | Description |
|---|---|
| Culture | Gets the culture of the word to hyphenate. |
| DividePos | Gets or sets the position at which the word should be divided. When a spellchecker has been connected with the SpellChecker property, this value has been calculated through the spellchecker. Otherwise it is zero. A TextControl uses this position to divide the word, when it is less or equal then MaxDividePos. |
| MaxDividePos | Gets the maximum dividing position. For example, when this value is 3, the first 3 characters of the word is the maximum part of the word which fit on the line. |
| Word | Gets the word to hyphenate. |