auto_hyphenation property

HyphenationOptions.auto_hyphenation property

Gets or sets value determining whether automatic hyphenation is turned on for the document. Default value for this property is False.

@property
def auto_hyphenation(self) -> bool:
    ...

@auto_hyphenation.setter
def auto_hyphenation(self, value: bool):
    ...

Examples

Shows how to configure automatic hyphenation.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.font.size = 24
builder.writeln('Lorem ipsum dolor sit amet, consectetur adipiscing elit, ' + 'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.')
doc.hyphenation_options.auto_hyphenation = True
doc.hyphenation_options.consecutive_hyphen_limit = 2
doc.hyphenation_options.hyphenation_zone = 720
doc.hyphenation_options.hyphenate_caps = True
doc.save(file_name=ARTIFACTS_DIR + 'Document.HyphenationOptions.docx')

See Also

HyphenationOptions constructor HyphenationOptions.consecutive_hyphen_limit property