TX Text Control .NET Server

WidowOrphanLines Property

Property|Introduced in 13.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK as TXTextControl.Core.dll from the private NuGet feed or Text Control Offline Packages
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

Description

Gets or sets the number of lines for widow/orphan control. Widow/orphan control avoids that a paragraph is started at the bottom of a page and that either, the majority of its lines, or only a few lines are displayed on the next page. This property's value determines how many lines must not be separated from the rest of the paragraph. For example, if this property is set to two, there must be at least three lines of the paragraph at the bottom of the previous page and at least three lines at the top of the next page. Otherwise, the complete paragraph is displayed on the next page. If this property is set to zero, widow/orphan control is disabled.

Syntax

public int WidowOrphanLines { get; set; }

Examples

The following example applies paragraph layout to selected report text by using ParagraphFormat.WidowOrphanLines.

textControl.Text = "First item\nSecond item\nThird item";
textControl.Select(0, textControl.Text.Length);
ParagraphFormat paragraphFormat = textControl.Selection.ParagraphFormat;

paragraphFormat.WidowOrphanLines = 100;
Console.WriteLine($"Widow Orphan Lines used by Paragraph Format: {paragraphFormat.WidowOrphanLines}");

textControl.Selection.ParagraphFormat = paragraphFormat;

Limitations

The property's value must be between 0 and 3.

Remarks

The property's default value is 0.

The property returns its default value when the text selection contains multiple paragraphs with mixed setting. The Selection.IsCommonValueSelected method can be used to check for mixed attributes.