register_dictionary method

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.

def register_dictionary(self, language: str, stream: io.BytesIO):
    ...

Parameter	Type	Description
language	str	A language name, e.g. “en-US”. See .NET documentation for “culture name” and RFC 4646 for details.
stream	io.BytesIO	A stream for the dictionary file in OpenOffice 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.

This method can also be used to register Null dictionary to preventHyphenation.callback from being called repeatedly for the same language.

def register_dictionary(self, language: str, file_name: str):
    ...

Parameter	Type	Description
language	str	A language name, e.g. “en-US”. See .NET documentation for “culture name” and RFC 4646 for details.
file_name	str	A path to the dictionary file in Open Office format.

Examples

Shows how to register a hyphenation dictionary.

# A hyphenation dictionary contains a list of strings that define hyphenation rules for the dictionary's language.
# When a document contains lines of text in which a word could be split up and continued on the next line,
# hyphenation will look through the dictionary's list of strings for that word's substrings.
# If the dictionary contains a substring, then hyphenation will split the word across two lines
# by the substring and add a hyphen to the first half.
# Register a dictionary file from the local file system to the "de-CH" locale.
aw.Hyphenation.register_dictionary('de-CH', MY_DIR + 'hyph_de_CH.dic')
self.assertTrue(aw.Hyphenation.is_dictionary_registered('de-CH'))
# Open a document containing text with a locale matching that of our dictionary,
# and save it to a fixed-page save format. The text in that document will be hyphenated.
doc = aw.Document(MY_DIR + 'German text.docx')
self.assertTrue(all((node for node in doc.first_section.body.first_paragraph.runs if node.as_run().font.locale_id == 2055)))
doc.save(ARTIFACTS_DIR + 'Hyphenation.dictionary.registered.pdf')
# Re-load the document after un-registering the dictionary,
# and save it to another PDF, which will not have hyphenated text.
aw.Hyphenation.unregister_dictionary('de-CH')
self.assertFalse(aw.Hyphenation.is_dictionary_registered('de-CH'))
doc = aw.Document(MY_DIR + 'German text.docx')
doc.save(ARTIFACTS_DIR + 'Hyphenation.dictionary.unregistered.pdf')

See Also

• module aspose.words
• class Hyphenation