TXTextControl.ParagraphFormat.KeepLinesTogether Property - TX Text Control .NET for Windows Forms

TX Text Control .NET for Windows FormsReference GuideTXTextControl NamespaceParagraphFormat ClassKeepLinesTogether Property

Gets or sets a value indicating whether a page break is allowed within the paragraph. If the property's value is true, a page break is not allowed. Otherwise, it is allowed.

Introduced: 13.0.

Syntax

C#
VB.NET

public bool KeepLinesTogether { get; set; }

Public Property KeepLinesTogether() As Boolean

Examples

The following example uses the KeepLinesTogether property and sets its value to true to NOT allow a page break.

C#
VB.NET

TXTextControl.ParagraphFormat format = new TXTextControl.ParagraphFormat();

format.Frame             = TXTextControl.Frame.Box;
format.FrameStyle        = TXTextControl.FrameStyle.Double;
format.KeepLinesTogether = true;

textControl1.Selection.ParagraphFormat = format;

Dim format As TXTextControl.ParagraphFormat = New TXTextControl.ParagraphFormat()

format.Frame             = TXTextControl.Frame.Box
format.FrameStyle        = TXTextControl.FrameStyle.Double
format.KeepLinesTogether = true

TextControl1.Selection.ParagraphFormat = format

Remarks

The property's default value is false.

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.