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

CustomHyphenationDefinitions is what IronPDF C# code uses for PDF generation. It represents the sources for custom hyphenation patterns and exceptions.

CustomHyphenationDefinitions matters when an application needs to configure or invoke PDF generation from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.

To use CustomHyphenationDefinitions, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include ExceptionSource, PatternSource. Assign options or invoke methods on the instance to configure or perform the operation. The custom hyphenation covers typical usage in C# end to end.

using IronPdf;

var instance = new CustomHyphenationDefinitions();
var current = instance.ExceptionSource;
// Read or assign other properties such as PatternSource, ExceptionSource

For the broader workflow, see the base URLs guide in the IronPDF C# documentation. For broader context, the PDF generation portion of the IronPDF C# API contains related types that work with CustomHyphenationDefinitions directly. CustomHyphenationDefinitions exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat CustomHyphenationDefinitions as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant CustomHyphenationDefinitions property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of CustomHyphenationDefinitions. Application code typically obtains or instantiates a single CustomHyphenationDefinitions and shares it across multiple IronPDF operations rather than recreating it per call.

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