PGetRuleAbove

Gets the state (on or off) and attributes of the Rule Above Paragraph settings applied to the selected text or to the paragraph containing the insertion point.

Query results

PMBool bOnOff;

false for rule above is off
true for rule above is on

short cLineStyle;

kParmDontCare to leave the line style unchanged
kLineNone or 0 (these are defined in PKeywords.h)
kLineHairline or 1
kLineHalfPoint or 2
kLineOnePoint or 3
kLineTwoPoint or 4
kLineFourPoint or 5
kLineSixPoint or 6
kLineEightPoint or 7
kLineTwelvePoint or 8
kLineThinThin or 9
kLineThickThin or 10
kLineThinThick or 11
kLineThinThickThin or 12
kLineThinDash or 13
kLineMediumDash or 14
kLineThickDash or 15
kLineSquares or 16
kLineDots or 17
kLineCustomSolid or 31 for a solid line of weight specified by dWeight

const char * sLineColor;

Line-color name exactly as it appears in Line Color pop-up list (maximum of31 characters)

short cLineWidth;

0 for Width of Text
1 for Width of Column

long xLeftIndent;

Indent from left edge of text or column, depending upon value of cLineWidth in twips

long xRightIndent;

Indent from right edge of text or column, depending upon value of cLineWidth in twips

short dWeight;

Weight of a custom line in tenths of a point (5.5 = 55)

PMBool bOpaque;

false for transparent background behind dotted, dashed, or compound lines.
true for opaque background behind dotted, dashed, or compound lines

short nLineTint;

Percentage of color applied to rule (from 0 to 100) in tenths of a percent (100 = 1000), although command uses only whole percentages

Defining or editing a style. If you are defining or editing a style using the PStyleBegin command, PageMaker gets the rule attributes for that style rather than for the selected text.

Multiple settings. If multiple paragraphs are selected and they have different attributes applied to them, PageMaker returns -2 or an empty string (depending upon the data type) for the parameters with conflicting settings.

Default returned with Pointer tool active. If the pointer tool is active, PageMaker gets the default settings.

dWeight ignored. The dWeight parameter is ignored when cLineStyle is -2.

PGetRuleAbove

Query results

See also