ParaModify Method

Build 1501 on 14/Nov/2017  This topic last edited on: 23/Mar/2016, at 12:19

Description

This function combines the functionalities of ParaGrow, ParaShrink, and ParaFit, thus stretches, shrinks or fills the current paragraph depending on its number of lines and the required number of lines of its style.

Note that even if it would not be possible to exactly fit paragraph, ParaModif sets the stretch/shrink parameters to the closest value.

Syntax

Text.ParaModify (strConf, nDelta, bFill, bSetBest)

strConf

(string): name of option set to be used in stretching or shrinking the current paragraph. If empty the default for the current paragraph style is used

nDelta (integer):

number of lines to increase (positive) or decrease (negative) the lenght of the paragraph

bFill (boolean):

true to fill the last paragraph line - i.e. the last line will contain as much text as possible

bSetBest (boolean):

true to set the best possible parameters found even if they don't reach the required number of lines

Return value

Error code

See also

ParaFit, ParaFitDlg, ParaFill, ParaFillDlg, ParaGrow, ParaGrowDlg, ParaShrink, ParaShrinkDlg, ParaNormal

Context

Text designer commands