ConsecutiveHyphenLimit

HyphenationOptions.ConsecutiveHyphenLimit property

Gets or sets the maximum number of consecutive lines that can end with hyphens. Default value for this property is 0.

public int ConsecutiveHyphenLimit { get; set; }

Remarks

If value of this property is set to 0, any number of consecutive lines can end with hyphens.

The property does not have effect when saving to fixed page formats e.g. PDF.

Examples

Shows how to configure automatic hyphenation.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(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.HyphenationOptions.AutoHyphenation = true;
doc.HyphenationOptions.ConsecutiveHyphenLimit = 2;
doc.HyphenationOptions.HyphenationZone = 720;
doc.HyphenationOptions.HyphenateCaps = true;

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

See Also

HyphenationOptions.AutoHyphenation HyphenationOptions.HyphenateCaps