Class CustomHyphenationDefinitions

Defines the sources for custom hyphenation patterns and exceptions. Sources can be local file paths or HTTP/HTTPS URLs.

Inheritance
System.Object
CustomHyphenationDefinitions
Namespace: IronPdf
Assembly: IronPdf.dll
Syntax
public class CustomHyphenationDefinitions : Object
Remarks

Local File Requirements:

URL Requirements:

Finding Pattern Files:

Pre-built hyphenation pattern files for many languages are available at:

https://github.com/hyphenation/tex-hyphen/tree/master/hyph-utf8/tex/generic/hyph-utf8/patterns/txt

File Content Requirements:

Pattern and exception files must contain only valid hyphenation pattern text.

The presence of comments, metadata, headers, or any non-pattern content (such as TeX directives,

encoding notes, or descriptive text) is not supported and will cause hyphenation integration to fail.

Examples: 

// Local file
PatternSource = "patterns/hyph-en-us.pat.txt"

// Remote URL - Use the raw content URL, not the GitHub page URL
// ✓ Correct (raw text):
PatternSource = "https://raw.githubusercontent.com/hyphenation/tex-hyphen/master/hyph-utf8/tex/generic/hyph-utf8/patterns/txt/hyph-en-us.pat.txt"


// ✗ Incorrect (HTML page):
// PatternSource = "https://github.com/hyphenation/tex-hyphen/blob/master/hyph-utf8/tex/generic/hyph-utf8/patterns/txt/hyph-en-us.pat.txt"


// For exception files
ExceptionSource = "https://raw.githubusercontent.com/hyphenation/tex-hyphen/master/hyph-utf8/tex/generic/hyph-utf8/patterns/txt/hyph-en-us.hyp.txt"

Note: When using GitHub URLs, click the "Raw" button to get the correct URL that points to the actual text content.

Constructors

CustomHyphenationDefinitions()

Declaration
public CustomHyphenationDefinitions()

Properties

ExceptionSource

Path or URL to the exceptions file (e.g., "hyph-en-us.hyp.txt").

Declaration
public string ExceptionSource { get; set; }
Property Value
Type Description
System.String

PatternSource

Path or URL to the patterns file (e.g., "hyph-en-us.pat.txt").

Declaration
public string PatternSource { get; set; }
Property Value
Type Description
System.String