DocumentBase.ConsecutiveHyphensLimit Property

Definition

Namespace:

Microsoft.Office.Tools.Word

Assembly:

Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Gets or sets the maximum number of consecutive lines that can end with hyphens.

public:
 property int ConsecutiveHyphensLimit { int get(); void set(int value); };

public int ConsecutiveHyphensLimit { get; set; }

member this.ConsecutiveHyphensLimit : int with get, set

Public Property ConsecutiveHyphensLimit As Integer

Property Value

Int32

The maximum number of consecutive lines that can end with hyphens.

Examples

The following code example limits the number of consecutive lines that can end with hyphens to two. To use this example, run it from the ThisDocument class in a document-level project.

private void DocumentConsecutiveHyphensLimit()
{
    this.AutoHyphenation = true;
    this.ConsecutiveHyphensLimit = 2;
}

Private Sub DocumentConsecutiveHyphensLimit()
    Me.AutoHyphenation = True
    Me.ConsecutiveHyphensLimit = 2
End Sub

Remarks

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