ParaStatus Object

Build 1501 on 14/Nov/2017  This topic last edited on: 14/Jan/2014, at 11:54

The ParaStatus object provides the control over typographical attributes of paragraphs of a text.

Methods and properties

Leading, space before and after, top compensation

Leading PropertyReturns or sets the paragraph's leading in millipoints.
HasLeading MethodReturns true if the HasLeading property has a value.
SpaceBefore PropertyReturns or sets the additional space above the paragraph expressed in millipoints.
HasSpaceBefore MethodReturns true if the SpaceBefore property has a value.
SpaceAfter PropertyReturns or sets the additional space below the paragraph expressed in millipoints.
HasSpaceAfter MethodReturns true if the SpaceAfter property has a value.
LeadingCol PropertyReturns or sets the leading for the first line in a justification area.
HasLeadingCol MethodReturns true if the LeadingCol property has a value.
LeadingColOn PropertyReturns or sets the status of the LeadingCol attribute.
HasLeadingColOn MethodReturns true if the LeadingColOn property has a value.

Column width and jump

LineWidth PropertyReturns or sets the column width in millipoints.
HasLineWidth MethodReturns true if the LineWidth property has a value.
AreaBreak PropertyReturns or sets the status of the new justification area.
HasAreaBreak MethodReturns true if the AreaBreak property has a value.

Hyphenation

Hyp PropertyReturns or sets hyphenation status for the paragraph.
HasHyp MethodReturns true if the Hyp property has a value.

Alignment

App PropertyReturns or sets the alignment of the paragraph lines.
HasApp MethodReturns true if the App property has a value.
LastApp PropertyReturns or sets the alignment of the last paragraph line.
HasLastApp MethodReturns true if the LastApp property has a value.
UseLastApp PropertyReturns or sets the status of the forced end line for the last paragraph line alignment
HasUseLastApp MethodReturns true if the UseLastApp property has a value.

Indents

StandardIndent PropertyReturns or sets the first line indent.
HasStandardIndent MethodReturns true if the StandardIndent property has a value.
NStandardIndent PropertyReturns or sets the number of lines to be affected by StandardIndent.
HasNStandardIndent MethodReturns true if the NStandardIndent property has a value.
LeftIndent PropertyReturns or sets the left indent expressed in millipoints.
HasLeftIndent MethodReturns true if the LeftIndent property has a value.
NLeftIndent PropertyReturns or sets the number of lines affected by LeftIndent.
HasNLeftIndent MethodReturns true if the NLeftIndent property has a value.
RightIndent PropertyReturns or sets the right indent expressed in millipoints.
HasRightIndent MethodReturns true if the RightIndent property has a value.
NRightIndent PropertyReturns or sets the number of lines affected by RightIndent.
HasNRightIndent MethodReturns true if the NRightIndent property has a value.

Vertical justification

TopVAdd PropertyReturns or sets the max. space that can be added above the paragraph.
HasTopVAdd MethodReturns true if the TopVAdd property has a value.
TopVSub PropertyReturns or sets the max. space to be subtracted above the paragraph.
HasTopVSub MethodReturns true if the TopVSub property has a value.
VAdd PropertyReturns or sets the max. space to be added between lines inside the paragraph.
HasVAdd MethodReturns true if the VAdd property has a value.
VSub PropertyReturns or sets the max. space to be subtracted between lines inside the paragraph.
HasVSub MethodReturns true if the VSub property has a value.

Text flow control

KeepTop PropertyReturns or sets the number of lines to be kept together at the start of the paragraph.
HasKeepTop MethodReturns true if the KeepTop property has a value.
KeepBot PropertyReturns or sets the number of lines to be kept together at the end of the paragraph.
HasKeepBot MethodReturns true if the KeepBot property has a value.
KeepNext PropertyReturns or sets the keep paragraph with next status.
HasKeepNext MethodReturns true if the KeepNext property has a value.

Word spacing

SpaceW PropertyReturns or sets the optimal width of the movable spaces.
HasSpaceW MethodReturns true if the SpaceW property has a value.
MinSpaceW PropertyReturns or sets the minimum width of the movable spaces.
HasMinSpaceW MethodReturns true if the MinSpaceW property has a value.
MaxSpaceW PropertyReturns or sets the maximum width of the movable spaces.
HasMaxSpaceW MethodReturns true if the MaxSpaceW property has a value.

Alignment to grid

GridH PropertyReturns or sets the baseline grid value or 0 if not set.
HasGridH MethodReturns true if the GridH property has a value.
GridOfs PropertyReturns or sets the baseline grid offset .
HasGridOfs MethodReturns true if the GridOfs property has a value.

Fillers

HasFillMode MethodReturns true if the FillMode property has a value.
FillMode PropertyReturns or sets fill mode.
HasFillSpaceLast MethodReturns true if the FillSpaceLast property has a value.
FillSpaceLast PropertyReturns or sets the space between the last fill character and the text expressed in millipoints.
HasFillSpaceBetween MethodReturns true if the FillSpaceBetween property has a value.
FillSpaceBetween PropertyReturns or sets the space between repeated fill characters expressed in millipoints.
HasFillSpaceAround MethodReturns true if the FillSpaceAround property has a value.
FillSpaceAround PropertyReturns or sets the space around fill character expressed in millipoints.
HasFillChar MethodReturns true if the FillChar property has a value.
FillChar PropertyReturns or sets the fill character.

Paragraph shrinking and stretching

SSLines PropertyReturns or sets the number of lines to remove or to add to the current paragraph.
HasSSLines MethodReturns true if the SSLines property has a value.
SSTrackStretch PropertyReturns or sets the change of tracking/stretching expressed in millipoints.
HasSSTrackStretch MethodReturns true if the SSTrackStretch property has a value.
SSCharBase PropertyReturns or sets the change of base of characters.
HasSSCharBase MethodReturns true if the SSCharBase property has a value.
SSWordSpace PropertyReturns or sets the change of space between words.
HasSSWordSpace MethodReturns true if the SSWordSpace property has a value.
SSCharSize PropertyReturns or sets the change of size of characters.
HasSSCharSize MethodReturns true if the SSCharSize property has a value.
SSScope PropertyReturns or sets the scope of the change.
HasSSScope MethodReturns true if the SSScope property has a value.

Drop capitals

DropLines PropertyReturns or sets the number of drop cap lines.
HasDropLines MethodReturns true if the DropLines property has a value.
DropChars PropertyReturns or sets the number of drop cap characters.
HasDropChars MethodReturns true if the DropChars property has a value.
DropRightMargin PropertyReturns or sets the right margin between the drop capital and the text, any positive number.
HasDropRightMargin MethodReturns true if the DropRightMargin property has a value.
DropVSCapital PropertyReturns or sets the vertical shift upwards of the drop capital.
HasDropVSCapital MethodReturns true if the DropVSCapital property has a value.
DropVSBaseline PropertyReturns or sets the vertical shift upwards of the baseline of the drop capital.
HasDropVSBaseline MethodReturns true if the DropVSBaseline property has a value.
DropRelBase PropertyReturns or sets the relative base of the drop capital
HasDropRelBase MethodReturns true if the DropRelBase property has a value.
DropFont PropertyReturns or sets the font for the drop capital.
HasDropFont MethodReturns true if the DropFont property has a value.
DropNextStyle PropertyReturns or sets the style name to activate after drop capital.
HasDropNextStyle MethodReturns true if the DropNextStyle property has a value.

Area and rules

ARReset MethodClears all the abs rules.
NAbsRules MethodReturns the number of abs rules.
HasAbsRules MethodReturns true if the abs rules properties have a value.
ARGray PropertyReturns or sets the tint of the nIdx abs rule. A positive integer in the range 0 - 100.
ARColor PropertyReturns or sets the color name of the nIdx abs rule.
ARLROrigin PropertyReturns or sets the position identifier for the ending point of the nIdx abs rule.
ARLRY PropertyReturns or sets the vertical offset from the default ending point of the nIdx abs rule.
ARLRX PropertyReturns or sets the horizontal offset from the default ending point of the nIdx abs rule.
ARULOrigin PropertyReturns or sets the position identifier for starting point of the nIdx abs rule.
ARULY PropertyReturns or sets the vertical offset from the default starting point of the nIdx abs rule.
ARULX PropertyReturns or sets the horizontal offset from the default starting point of the nIdx abs rule.

Reset and Edit

Reset MethodResets all the properties to 'no value'.
Edit MethodEdits all the object's properties with a dialog.

To create a ParaStatus object:

dim objPS = Text.GetParaStatus

dim objPS = Text.GetParaParaStatus

dim objPS = Text.GetDefaultParaStatus

See also

Overview

TextStatus Object