:: com :: sun :: star :: style ::

service ParagraphProperties
Description
describes the style of paragraphs.
Developers Guide
7.3.2 Text Documents - Working with Text Documents - Formatting

Properties' Summary
ParaAdjust determines the adjustment of a paragraph.
ParaLineSpacing [ OPTIONAL ]
contains the type of the line spacing of a paragraph.
ParaBackColor [ OPTIONAL ]
contains the paragraph background color.
ParaBackTransparent [ OPTIONAL ]
This value is true if the paragraph background color is set to transparent.
ParaBackGraphicURL [ OPTIONAL ]
contains the value of a link for the background graphic of a paragraph.
ParaBackGraphicFilter [ OPTIONAL ]
contains the name of the graphic filter for the background graphic of a paragraph.
ParaBackGraphicLocation [ OPTIONAL ]
contains the value for the position of a background graphic.
ParaLastLineAdjust determines the adjustment of the last line.
ParaExpandSingleWord [ OPTIONAL ]
determines if single words are stretched.
ParaLeftMargin determines the left margin of the paragraph in 100th mm.
ParaRightMargin determines the right margin of the paragraph in 100th mm.
ParaTopMargin determines the top margin of the paragraph in 100th mm.
ParaBottomMargin determines the bottom margin of the paragraph in 100th mm.
ParaLineNumberCount [ OPTIONAL ]
determines if the paragraph is included in the line numbering.
ParaLineNumberStartValue [ OPTIONAL ]
contains the start value for the line numbering.
PageDescName [ OPTIONAL ]
If this property is set, it creates a page break before the paragraph it belongs to and assigns the value as the name of the new page style sheet to use.
PageNumberOffset [ OPTIONAL ]
If a page break property is set at a paragraph, this property contains the new value for the page number.
ParaRegisterModeActive [ OPTIONAL ]
determines if the register mode is applied to a paragraph.
ParaTabStops [ OPTIONAL ]
specifies the positions and kinds of thei tab stops within this paragraph.
ParaStyleName [ OPTIONAL ]
contains the name of the current paragraph style.
DropCapFormat [ OPTIONAL ]
specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted.
DropCapWholeWord [ OPTIONAL ]
specifies if the property DropCapFormat is applied to the whole first word.
ParaKeepTogether [ OPTIONAL ]
Setting this property to true prevents page or column breaks between this and the following paragraph.
ParaSplit [ OPTIONAL ]
Setting this property to false prevents the paragraph from getting split into two pages or columns.
NumberingLevel [ OPTIONAL ]
specifies the numbering level of the paragraph.
NumberingRules [ OPTIONAL ]
contains the numbering rules applied to this paragraph.
NumberingStartValue [ OPTIONAL ]
specifies the start value for numbering if a new numbering starts at this paragraph.
ParaIsNumberingRestart [ OPTIONAL ]
determines if the numbering rules restart, counting at the current paragraph.
NumberingStyleName [ OPTIONAL ]
specifies the name of the style for the numbering.
ParaOrphans [ OPTIONAL ]
specifies the minimum number of lines of the paragraph that have to be at bottom of a page if the paragraph is spread over more than one page.
ParaWidows [ OPTIONAL ]
specifies the minimum number of lines of the paragraph that have to be at top of a page if the paragraph is spread over more than one page.
ParaShadowFormat [ OPTIONAL ]
determines the type, color, and size of the shadow.
LeftBorder [ OPTIONAL ]
contains the left border of the object.
RightBorder [ OPTIONAL ]
contains the right border of the object.
TopBorder [ OPTIONAL ]
contains the top border of the object.
BottomBorder [ OPTIONAL ]
contains the bottom border of the object.
BorderDistance [ OPTIONAL ]
contains the distance from the border to the object.
LeftBorderDistance [ OPTIONAL ]
contains the distance from the left border to the object.
RightBorderDistance [ OPTIONAL ]
contains the distance from the right border to the object.
TopBorderDistance [ OPTIONAL ]
contains the distance from the top border to the object.
BottomBorderDistance [ OPTIONAL ]
contains the distance from the bottom border to the object.
BreakType [ OPTIONAL ]
determins the type of break that is applied at the beginning of the table.
DropCapCharStyleName [ OPTIONAL ]
specifies the character style name for drop caps.
ParaFirstLineIndent [ OPTIONAL ]
specifies the indent for the first line.
ParaIsAutoFirstLineIndent [ OPTIONAL ]
determines if the first line should be indented automatically.
ParaIsHyphenation specifies if automatic hyphenation is applied.
ParaHyphenationMaxHyphens [ OPTIONAL ]
specifies the maximum number of consecutive hyphens.
ParaHyphenationMaxLeadingChars [ OPTIONAL ]
specifies the maximum number of characters to remain before the hyphen character (when hyphenation is applied).
ParaHyphenationMaxTrailingChars [ OPTIONAL ]
specifies the maximum number of characters to remain after the hyphen character (when hyphenation is applied).
ParaVertAlignment [ OPTIONAL ]
specifies the vertical alignment of a paragraph.
ParaUserDefinedAttributes [ OPTIONAL ]
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.
Properties' Details
ParaAdjust
ParagraphAdjust ParaAdjust;
Description
determines the adjustment of a paragraph.
ParaLineSpacing
LineSpacing ParaLineSpacing;
[ OPTIONAL ]
Description
contains the type of the line spacing of a paragraph.
ParaBackColor
long ParaBackColor;
[ OPTIONAL ]
Description
contains the paragraph background color.
ParaBackTransparent
boolean ParaBackTransparent;
[ OPTIONAL ]
Description
This value is true if the paragraph background color is set to transparent.
ParaBackGraphicURL
string ParaBackGraphicURL;
[ OPTIONAL ]
Description
contains the value of a link for the background graphic of a paragraph.
ParaBackGraphicFilter
string ParaBackGraphicFilter;
[ OPTIONAL ]
Description
contains the name of the graphic filter for the background graphic of a paragraph.
ParaBackGraphicLocation
GraphicLocation ParaBackGraphicLocation;
[ OPTIONAL ]
Description
contains the value for the position of a background graphic.
See also
GraphicLocation
ParaLastLineAdjust
short ParaLastLineAdjust;
Description
determines the adjustment of the last line.

It is only valid if ParagraphProperties::ParaAdjust is set to ParagraphAdjust::BLOCK .

ParaExpandSingleWord
boolean ParaExpandSingleWord;
[ OPTIONAL ]
Description
determines if single words are stretched.

It is only valid if ParagraphProperties::ParaAdjust and ParagraphProperties::ParaLastLineAdjust are also valid.

ParaLeftMargin
long ParaLeftMargin;
Description
determines the left margin of the paragraph in 100th mm.
ParaRightMargin
long ParaRightMargin;
Description
determines the right margin of the paragraph in 100th mm.
ParaTopMargin
long ParaTopMargin;
Description
determines the top margin of the paragraph in 100th mm.

The distance between two paragraphs is specified by:

  • either the bottom margin of the previous paragraph.
  • or the top margin of the following paragraph.
The greater one is chosen.
ParaBottomMargin
long ParaBottomMargin;
Description
determines the bottom margin of the paragraph in 100th mm.

The distance between two paragraphs is specified by:

  • either the bottom margin of the previous paragraph
  • or the top margin of the following paragraph.
The greater one is chosen.
ParaLineNumberCount
boolean ParaLineNumberCount;
[ OPTIONAL ]
Description
determines if the paragraph is included in the line numbering.
ParaLineNumberStartValue
long ParaLineNumberStartValue;
[ OPTIONAL ]
Description
contains the start value for the line numbering.
PageDescName
string PageDescName;
[ OPTIONAL ]
Description
If this property is set, it creates a page break before the paragraph it belongs to and assigns the value as the name of the new page style sheet to use.
PageNumberOffset
short PageNumberOffset;
[ OPTIONAL ]
Description
If a page break property is set at a paragraph, this property contains the new value for the page number.
ParaRegisterModeActive
boolean ParaRegisterModeActive;
[ OPTIONAL ]
Description
determines if the register mode is applied to a paragraph.

Remark: Register mode is only used if the register mode property of the page style is switched on.

ParaTabStops
sequence< TabStop > ParaTabStops;
[ OPTIONAL ]
Description
specifies the positions and kinds of thei tab stops within this paragraph.
ParaStyleName
string ParaStyleName;
[ OPTIONAL ]
Description
contains the name of the current paragraph style.
DropCapFormat
DropCapFormat DropCapFormat;
[ OPTIONAL ]
Description
specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted.
DropCapWholeWord
boolean DropCapWholeWord;
[ OPTIONAL ]
Description
specifies if the property DropCapFormat is applied to the whole first word.
ParaKeepTogether
boolean ParaKeepTogether;
[ OPTIONAL ]
Description
Setting this property to true prevents page or column breaks between this and the following paragraph.

This feature is useful for preventing title paragraphs to be the last line on a page or column.

ParaSplit
boolean ParaSplit;
[ OPTIONAL ]
Description
Setting this property to false prevents the paragraph from getting split into two pages or columns.
NumberingLevel
short NumberingLevel;
[ OPTIONAL ]
Description
specifies the numbering level of the paragraph.
NumberingRules
::com::sun::star::container::XIndexReplace NumberingRules;
[ OPTIONAL ]
Description
contains the numbering rules applied to this paragraph.
NumberingStartValue
short NumberingStartValue;
[ OPTIONAL ]
Description
specifies the start value for numbering if a new numbering starts at this paragraph.
ParaIsNumberingRestart
boolean ParaIsNumberingRestart;
[ OPTIONAL ]
Description
determines if the numbering rules restart, counting at the current paragraph.
NumberingStyleName
string NumberingStyleName;
[ OPTIONAL ]
Description
specifies the name of the style for the numbering.

The name must be one of the names which are available via XStyleFamiliesSupplier .

ParaOrphans
byte ParaOrphans;
[ OPTIONAL ]
Description
specifies the minimum number of lines of the paragraph that have to be at bottom of a page if the paragraph is spread over more than one page.
ParaWidows
byte ParaWidows;
[ OPTIONAL ]
Description
specifies the minimum number of lines of the paragraph that have to be at top of a page if the paragraph is spread over more than one page.
ParaShadowFormat
::com::sun::star::table::ShadowFormat ParaShadowFormat;
[ OPTIONAL ]
Description
determines the type, color, and size of the shadow.
See also
com.sun.star.table.ShadowFormat
LeftBorder
::com::sun::star::table::BorderLine LeftBorder;
[ OPTIONAL ]
Description
contains the left border of the object.
RightBorder
::com::sun::star::table::BorderLine RightBorder;
[ OPTIONAL ]
Description
contains the right border of the object.
TopBorder
::com::sun::star::table::BorderLine TopBorder;
[ OPTIONAL ]
Description
contains the top border of the object.
BottomBorder
::com::sun::star::table::BorderLine BottomBorder;
[ OPTIONAL ]
Description
contains the bottom border of the object.
BorderDistance
long BorderDistance;
[ OPTIONAL ]
Description
contains the distance from the border to the object.
LeftBorderDistance
long LeftBorderDistance;
[ OPTIONAL ]
Description
contains the distance from the left border to the object.
RightBorderDistance
long RightBorderDistance;
[ OPTIONAL ]
Description
contains the distance from the right border to the object.
TopBorderDistance
long TopBorderDistance;
[ OPTIONAL ]
Description
contains the distance from the top border to the object.
BottomBorderDistance
long BottomBorderDistance;
[ OPTIONAL ]
Description
contains the distance from the bottom border to the object.
BreakType
BreakType BreakType;
[ OPTIONAL ]
Description
determins the type of break that is applied at the beginning of the table.
See also
com.sun.star.style.BreakType
DropCapCharStyleName
string DropCapCharStyleName;
[ OPTIONAL ]
Description
specifies the character style name for drop caps.
ParaFirstLineIndent
long ParaFirstLineIndent;
[ OPTIONAL ]
Description
specifies the indent for the first line.
ParaIsAutoFirstLineIndent
boolean ParaIsAutoFirstLineIndent;
[ OPTIONAL ]
Description
determines if the first line should be indented automatically.
ParaIsHyphenation
boolean ParaIsHyphenation;
Description
specifies if automatic hyphenation is applied.
ParaHyphenationMaxHyphens
short ParaHyphenationMaxHyphens;
[ OPTIONAL ]
Description
specifies the maximum number of consecutive hyphens.
ParaHyphenationMaxLeadingChars
short ParaHyphenationMaxLeadingChars;
[ OPTIONAL ]
Description
specifies the maximum number of characters to remain before the hyphen character (when hyphenation is applied).
ParaHyphenationMaxTrailingChars
short ParaHyphenationMaxTrailingChars;
[ OPTIONAL ]
Description
specifies the maximum number of characters to remain after the hyphen character (when hyphenation is applied).
ParaVertAlignment
short ParaVertAlignment;
[ OPTIONAL ]
Description
specifies the vertical alignment of a paragraph.
See also
::com::sun::star::text::ParagraphVertAlign
ParaUserDefinedAttributes
::com::sun::star::container::XNameContainer ParaUserDefinedAttributes;
[ OPTIONAL ]
Description
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.
See also
::com::sun::star::xml::AttributeContainer

 
Top of Page