DocumentHyphenationOptions Property

Provides access to document hyphenation options.

Namespace:  Aspose.Words
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 20.7.0

Syntax

public HyphenationOptions HyphenationOptions { get; }

Property Value

Type: HyphenationOptions

Examples

Shows how to configure document hyphenation options.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Set this to insert a page break before this paragraph
builder.Font.Size = 24;
builder.ParagraphFormat.SuppressAutoHyphens = false;

builder.Writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
                "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");

doc.HyphenationOptions.AutoHyphenation = true;
doc.HyphenationOptions.ConsecutiveHyphenLimit = 2;
doc.HyphenationOptions.HyphenationZone = 720; // 0.5 inch
doc.HyphenationOptions.HyphenateCaps = true;

// Each paragraph has this flag that can be set to suppress hyphenation
Assert.False(builder.ParagraphFormat.SuppressAutoHyphens);

doc.Save(ArtifactsDir + "Document.HyphenationOptions.docx");

See Also