PParaOptions

Sets paragraph options. The extent of the action depends on which tool is active, whether any text is selected, and whether a publication is open when the command is executed.

Command constructors

This class has two constructors.

PParaOptions(PMBool bKeepTog, PMBool bColumnBreak, PMBool bPageBreak, PMBool bIncludeTOC, short nKeepWith, short nWidow, short nOrphan);

PMBool bKeepTog;
off or 0 (zero)
on or 1 to keep lines of a paragraph together, rather than split between different columns, pages, or graphics
kParmDontCare to leave existing setting unchanged
PMBool bColumnBreak;
off or 0 (zero)
on or 1 to specify that a paragraph begins a new column
kParmDontCare to leave existing setting unchanged
PMBool bPageBreak;
off or 0 (zero)
on or 1 to specify that a paragraph begins a new page
kParmDontCare to leave existing setting unchanged
PMBool bIncludeTOC;
off or 0 (zero)
on or 1 to specify that the paragraph text is included in the table of contents
kParmDontCare to leave existing setting unchanged
short nKeepWith;
kParmNone or 0 (zero)
1 or 2 or 3 to specify the number of lines to remain with the next paragraph (useful to keep headings and text together)
kParmDontCare to leave existing number unchanged
short nWidow;
kParmNone or 0 (zero)
1 or 2 or 3 to specify the maximum lines for widow control
kParmDontCare to leave existing number unchanged
short nOrphan;
kParmNone or 0 (zero)
1 or 2 or 3 to specify the maximum lines for orphan control
kParmDontCare to leave existing number unchanged

PParaOptions(PGetParaOptions& options);

This constructor uses the values from a PGetParaOptions object.

Example. Assuming a paragraph is selected and it is a heading, the example specifies the following:

Heading will not split over different columns, from page to page, or over graphics that have text-wrap attributes (useful if you have a two-line heading).
Heading begins a new column.
Heading need not begin a new page.
Heading is included in the table of contents.
Current widow and orphan control is acceptable.

PGetParaOptions savedOptions;

PParaOptions(1, 1, 0, 1 , 0, -2, -2);

...

PParaOptions(savedOptions);

// restore old settings

PParaOptions

Command constructors

See also