Javascript: TXTextControl.ParagraphFormat.getWidowOrphanLines Method

Gets 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. Takes a callback function with one parameter as a parameter. The callback function is called with the value as parameter upon receiving the information from the server.

Syntax

[JavaScript]
<void> ParagraphFormat.getWidowOrphanLines(<function> callback);
Parameter Description
callback

A function with one parameter. The callback function is called with the value as parameter upon receiving the information from the server. This parameter is the number of lines for widow/orphan control.

Remarks

The property's default value is 0. The property returns its default value, if the text selection contains multiple paragraphs with different values for this property.

See Also