Hyphenation class

Hyphenation class

Provides methods for working with hyphenation dictionaries. These dictionaries prescribe where words of a specific language can be hyphenated. To learn more, visit the Working with Hyphenation documentation article.

Properties

Name Description
callback Gets or sets callback interface used to request dictionaries when page layout of the document is built. This allows delay loading of dictionaries which may be useful when processing documents in many languages.
warning_callback Called during a load hyphenation patterns, when an issue is detected that might result in formatting fidelity loss.

Methods

Name Description
is_dictionary_registered(language) Returns False if for the specified language there is no dictionary registered or if registered is Null dictionary, True otherwise.
register_dictionary(language, stream) Registers and loads a hyphenation dictionary for the specified language from a stream. Throws if dictionary cannot be read or has invalid format.
register_dictionary(language, file_name) Registers and loads a hyphenation dictionary for the specified language from file. Throws if dictionary cannot be read or has invalid format.
unregister_dictionary(language) Unregisters a hyphenation dictionary for the specified language.

See Also