Meziantou.FrameworkHyphenatorOptions Class
Specifies how a Hyphenator is loaded and where it allows a word to break.
public sealed class HyphenatorOptionsRemarks
The limits protect the caller from pattern files that come from an untrusted source: a file that exceeds one is rejected before memory is allocated for it.
Constructors
| Name | Description |
|---|---|
| HyphenatorOptions() |
HyphenatorOptions()
HyphenatorOptions.cspublic HyphenatorOptions()No documentation is available.
Properties
| Name | Description |
|---|---|
| Default | Gets the default options. |
| LeftHyphenMin | Gets the smallest number of characters before the first break of a word. The default is 2. |
| MaxInputLength | Gets the greatest length of the patterns, and of the exceptions, in UTF-16 code units or in UTF-8 bytes. The default is 8 MiB. |
| MaxPatternCount | Gets the greatest number of patterns, and of exceptions, a hyphenator accepts. The default is 250,000. |
| MaxPatternLength | Gets the greatest number of letters of a pattern or of an exception. The default is 64. |
| MaxWordLength | Gets the greatest length, in UTF-16 code units, of a word that is hyphenated: a longer word has no break. The default is 255. |
| RightHyphenMin | Gets the smallest number of characters after the last break of a word. The default is 3. |
Default
HyphenatorOptions.csLeftHyphenMin
HyphenatorOptions.csGets the smallest number of characters before the first break of a word. The default is 2.
public int LeftHyphenMin { get; init; }Property value
Exceptions
ArgumentOutOfRangeException- The value is less than 1.
Remarks
The value depends on the language; it is the \lefthyphenmin of TeX. A character is an extended grapheme cluster.
MaxInputLength
HyphenatorOptions.csGets the greatest length of the patterns, and of the exceptions, in UTF-16 code units or in UTF-8 bytes. The default is 8 MiB.
public long MaxInputLength { get; init; }MaxPatternCount
HyphenatorOptions.csGets the greatest number of patterns, and of exceptions, a hyphenator accepts. The default is 250,000.
public int MaxPatternCount { get; init; }MaxPatternLength
HyphenatorOptions.csGets the greatest number of letters of a pattern or of an exception. The default is 64.
public int MaxPatternLength { get; init; }MaxWordLength
HyphenatorOptions.csGets the greatest length, in UTF-16 code units, of a word that is hyphenated: a longer word has no break. The default is 255.
public int MaxWordLength { get; init; }RightHyphenMin
HyphenatorOptions.csGets the smallest number of characters after the last break of a word. The default is 3.
public int RightHyphenMin { get; init; }Property value
Exceptions
ArgumentOutOfRangeException- The value is less than 1.
Remarks
The value depends on the language; it is the \righthyphenmin of TeX. A character is an extended grapheme cluster.