service ParagraphProperties in module com::sun::star::style::

(Global Index)

Syntax

service ParagraphProperties;

Description

describes the style of paragraphs.

Property Summary

ParaAdjust determines the adjustment of a paragraph.

ParaLineSpacing contains the type of the line spacing of a paragraph.

ParaBackColor contains the paragraph background color.

ParaBackTransparent This value is true if the paragraph background color is set to transparent.

ParaBackGraphicURL contains the value of a link for the background graphic of a paragraph.

ParaBackGraphicFilter contains the name of the graphic filter for the background graphic of a paragraph.

ParaBackGraphicLocation contains the value for the position of a background graphic.

ParaLastLineAdjust determines the adjustment of the last line.

ParaExpandSingleWord 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 determines if the paragraph is included in the line numbering.

ParaLineNumberStartValue contains the start value for the line numbering.

ParaIsHyphenation prevents the paragraph from getting hyphenated.

PageDescName 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 If a page break property is set at a paragraph, this property contains the new value for the page number.

ParaRegisterModeActive determines if the register mode is applied to a paragraph.

ParaTabStops specifies the positions and kinds of thei tab stops within this paragraph.

ParaStyleName contains the name of the current paragraph style.

DropCapFormat specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted.

DropCapWholeWord specifies if the property DropCapFormat is applied to the whole first word.

ParaKeepTogether Setting this property to true prevents page or column breaks between this and the following paragraph.

ParaSplit Setting this property to false prevents the paragraph from getting split into two pages or columns.

NumberingLevel specifies the numbering level of the paragraph.

NumberingRules contains the numbering rules applied to this paragraph.

NumberingStartValue specifies the start value for numbering if a new numbering starts at this paragraph.

ParaIsNumberingRestart determines if the numbering rules restart, counting at the current paragraph.

NumberingStyleName specifies the name of the style for the numbering.

ParaOrphans 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 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 determines the type, color, and size of the shadow.

IsHangingPunctuation determines if hanging punctuation is allowed.

IsCharacterDistance determines if a distance between asian text, western text or complex text is set.

IsForbiddenRules determines if the the rules for forbidden characters at the start or end of text lines are considered.

Property Details



ParaAdjust

Syntax

com::sun::star::style::ParagraphAdjust ParaAdjust;

Description

determines the adjustment of a paragraph.


ParaLineSpacing [ O P T I O N A L ]

Syntax

com::sun::star::style::LineSpacing ParaLineSpacing;

Description

contains the type of the line spacing of a paragraph.


ParaBackColor [ O P T I O N A L ]

Syntax

long ParaBackColor;

Description

contains the paragraph background color.


ParaBackTransparent [ O P T I O N A L ]

Syntax

boolean ParaBackTransparent;

Description

This value is true if the paragraph background color is set to transparent.


ParaBackGraphicURL [ O P T I O N A L ]

Syntax

string ParaBackGraphicURL;

Description

contains the value of a link for the background graphic of a paragraph.


ParaBackGraphicFilter [ O P T I O N A L ]

Syntax

string ParaBackGraphicFilter;

Description

contains the name of the graphic filter for the background graphic of a paragraph.


ParaBackGraphicLocation [ O P T I O N A L ]

Syntax

com::sun::star::style::GraphicLocation ParaBackGraphicLocation;

Description

contains the value for the position of a background graphic.

See also

GraphicLocation

ParaLastLineAdjust

Syntax

short ParaLastLineAdjust;

Description

determines the adjustment of the last line.

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


ParaExpandSingleWord [ O P T I O N A L ]

Syntax

boolean ParaExpandSingleWord;

Description

determines if single words are stretched.

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


ParaLeftMargin

Syntax

long ParaLeftMargin;

Description

determines the left margin of the paragraph in 100th mm.


ParaRightMargin

Syntax

long ParaRightMargin;

Description

determines the right margin of the paragraph in 100th mm.


ParaTopMargin

Syntax

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

Syntax

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 [ O P T I O N A L ]

Syntax

boolean ParaLineNumberCount;

Description

determines if the paragraph is included in the line numbering.


ParaLineNumberStartValue [ O P T I O N A L ]

Syntax

long ParaLineNumberStartValue;

Description

contains the start value for the line numbering.


ParaIsHyphenation

Syntax

boolean ParaIsHyphenation;

Description

prevents the paragraph from getting hyphenated.


PageDescName [ O P T I O N A L ]

Syntax

string PageDescName;

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 [ O P T I O N A L ]

Syntax

short PageNumberOffset;

Description

If a page break property is set at a paragraph, this property contains the new value for the page number.


ParaRegisterModeActive [ O P T I O N A L ]

Syntax

boolean ParaRegisterModeActive;

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 [ O P T I O N A L ]

Syntax

sequence< com::sun::star::style::TabStop > ParaTabStops;

Description

specifies the positions and kinds of thei tab stops within this paragraph.


ParaStyleName [ O P T I O N A L ]

Syntax

string ParaStyleName;

Description

contains the name of the current paragraph style.


DropCapFormat [ O P T I O N A L ]

Syntax

com::sun::star::style::DropCapFormat DropCapFormat;

Description

specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted.


DropCapWholeWord [ O P T I O N A L ]

Syntax

boolean DropCapWholeWord;

Description

specifies if the property DropCapFormat is applied to the whole first word.


ParaKeepTogether [ O P T I O N A L ]

Syntax

boolean ParaKeepTogether;

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 [ O P T I O N A L ]

Syntax

boolean ParaSplit;

Description

Setting this property to false prevents the paragraph from getting split into two pages or columns.


NumberingLevel [ O P T I O N A L ]

Syntax

short NumberingLevel;

Description

specifies the numbering level of the paragraph.


NumberingRules

Syntax

com::sun::star::container::XIndexReplace NumberingRules;

Description

contains the numbering rules applied to this paragraph.


NumberingStartValue [ O P T I O N A L ]

Syntax

short NumberingStartValue;

Description

specifies the start value for numbering if a new numbering starts at this paragraph.


ParaIsNumberingRestart [ O P T I O N A L ]

Syntax

boolean ParaIsNumberingRestart;

Description

determines if the numbering rules restart, counting at the current paragraph.


NumberingStyleName [ O P T I O N A L ]

Syntax

string NumberingStyleName;

Description

specifies the name of the style for the numbering.

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


ParaOrphans [ O P T I O N A L ]

Syntax

byte ParaOrphans;

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 [ O P T I O N A L ]

Syntax

byte ParaWidows;

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 [ O P T I O N A L ]

Syntax

com::sun::star::table::ShadowFormat ParaShadowFormat;

Description

determines the type, color, and size of the shadow.

See also

com.sun.star.table.ShadowFormat

IsHangingPunctuation [ O P T I O N A L ]

Syntax

boolean IsHangingPunctuation;

Description

determines if hanging punctuation is allowed.


IsCharacterDistance [ O P T I O N A L ]

Syntax

boolean IsCharacterDistance;

Description

determines if a distance between asian text, western text or complex text is set.


IsForbiddenRules [ O P T I O N A L ]

Syntax

boolean IsForbiddenRules;

Description

determines if the the rules for forbidden characters at the start or end of text lines are considered.

Top of Page