DS Server

ParagraphFormat Object

Object|Introduced in 26.0

Description

Represents the formatting attributes of a paragraph.

Syntax

ParagraphFormat

Examples

The following example demonstrates ParagraphFormat in a practical document-editing workflow. It represents the formatting attributes of a paragraph.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.paragraphFormat.getAbsoluteLineSpacing(
    function(result) {
        console.log("get absolute line spacing result:", result);
    },
    onTxError
);

Members

Methods

Method	Description
getAbsoluteLineSpacing	Gets the line spacing of a paragraph in twips.
getAlignment	Gets the horizontal text alignment.
getBackColor	Gets the background color of a paragraph.
getBottomDistance	Gets the bottom distance, in twips, between this and the next paragraph.
getDirection	Gets the writing direction.
getFrame	Gets the framesetting of the paragraph.
getFrameDistance	Gets the distance, in twips, between the text and the paragraph's frame.
getFrameLineColor	Gets the color used for the frame lines of a paragraph.
getFrameLineWidth	Gets the line width, in twips, of the paragraph's frame.
getFrameStyle	Gets the style of the paragraph's frame.
getHangingIndent	Gets the distance, in twips, for the hanging indent.
getJustification	Gets the kind of justification in documents containing Arabic or Hebrew characters.
getKeepLinesTogether	Gets a value indicating whether a page break is allowed within the paragraph.
getKeepWithNext	Gets whether the paragraph is displayed on the same page as its following paragraph.
getLeftIndent	Gets the distance, in twips, between the left edge of the Text Control and the left edge of the text.
getLineSpacing	Gets the line spacing of a paragraph as a percentage of the font size.
getPageBreakBefore	Gets whether the paragraph is always displayed on top of a page.
getRightIndent	Gets the distance, in twips, between the right edge of a Text Control document and the right edge of the text.
getStructureLevel	Gets the structure level of a paragraph in the document. The level can be between 0 and 10. A level of 0 indicates that the paragraph belongs to the body of the document.
getTabLeaders	Gets an array containing the tab leaders in a paragraph. A tab leader defines how a tab gap is filled.
getTabPositions	Gets the absolute tab stop positions, in twips, in a paragraph.
getTabTypes	Gets the tab types in a paragraph.
getTopDistance	Gets the distance, in twips, between this and the previous paragraph.
getWidowOrphanLines	Gets the number of lines for widow/orphan control.
setAbsoluteLineSpacing	Sets the line spacing of a paragraph in twips.
setAlignment	Sets the horizontal text alignment.
setBackColor	Sets the background color of a paragraph.
setBottomDistance	Sets the bottom distance, in twips, between this and the next paragraph.
setDirection	Sets the writing direction.
setFrame	Sets the framesetting of the paragraph.
setFrameDistance	Sets the distance, in twips, between the text and the paragraph's frame.
setFrameLineColor	Sets the color used for the frame lines of a paragraph.
setFrameLineWidth	Sets the line width, in twips, of the paragraph's frame.
setFrameStyle	Sets the style of the paragraph's frame.
setHangingIndent	Sets the distance, in twips, for the hanging indent.
setJustification	Sets the kind of justification in documents containing Arabic or Hebrew characters.
setKeepLinesTogether	Sets a value indicating whether a page break is allowed within the paragraph.
setKeepWithNext	Sets whether paragraph is displayed on the same page as its following paragraph.
setLeftIndent	Sets the distance, in twips, between the left edge of the Text Control and the left edge of the text.
setLineSpacing	Sets the line spacing of a paragraph as a percentage of the font size.
setPageBreakBefore	Sets whether the paragraph is always displayed on top of a page.
setRightIndent	Sets the distance, in twips, between the right edge of a Text Control document and the right edge of the text.
setStructureLevel	Sets the structure level of a paragraph in the document. The level can be between 0 and 10. A level of 0 indicates that the paragraph belongs to the body of the document.
setTabLeaders	Sets an array containing the tab leaders in a paragraph. A tab leader defines how a tab gap is filled.
setTabPositions	Sets an array containing the absolute tab stop positions, in twips, in a paragraph.
setTabTypes	Sets an array containing the tab types in a paragraph.
setTopDistance	Sets distance, in twips, between this and the previous paragraph.
setWidowOrphanLines	Sets the number of lines for widow/orphan control.

Enumerations

Enumeration	Description
Attribute	Determines a certain paragraph format attribute.