Service ParagraphProperties

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

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

service ParagraphProperties

Description: describes the style of paragraphs.

Developers Guide: Text - Formatting

Properties' Summary
ParagraphAdjust ParaAdjust	determines the adjustment of a paragraph.
LineSpacing ParaLineSpacing	[ OPTIONAL ] contains the type of the line spacing of a paragraph.
::com::sun::star::util::Color ParaBackColor	[ OPTIONAL ] contains the paragraph background color.
boolean ParaBackTransparent	[ OPTIONAL ] This value is true if the paragraph background color is set to transparent.
string ParaBackGraphicURL	[ OPTIONAL ] contains the value of a link for the background graphic of a paragraph.
string ParaBackGraphicFilter	[ OPTIONAL ] contains the name of the graphic filter for the background graphic of a paragraph.
GraphicLocation ParaBackGraphicLocation	[ OPTIONAL ] contains the value for the position of a background graphic.
short ParaLastLineAdjust	determines the adjustment of the last line.
boolean ParaExpandSingleWord	[ OPTIONAL ] determines if single words are stretched.
long ParaLeftMargin	determines the left margin of the paragraph in 100th mm.
long ParaRightMargin	determines the right margin of the paragraph in 100th mm.
long ParaTopMargin	determines the top margin of the paragraph in 100th mm.
long ParaBottomMargin	determines the bottom margin of the paragraph in 100th mm.
boolean ParaLineNumberCount	[ OPTIONAL ] determines if the paragraph is included in the line numbering.
long ParaLineNumberStartValue	[ OPTIONAL ] contains the start value for the line numbering.
string 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.
short PageNumberOffset	[ OPTIONAL ] If a page break property is set at a paragraph, this property contains the new value for the page number.
boolean ParaRegisterModeActive	[ OPTIONAL ] determines if the register mode is applied to a paragraph.
sequence< TabStop > ParaTabStops	[ OPTIONAL ] specifies the positions and kinds of thei tab stops within this paragraph.
string ParaStyleName	[ OPTIONAL ] contains the name of the current paragraph style.
[ readonly maybevoid ] string PageStyleName	[ OPTIONAL ] contains the name of the current page style.
DropCapFormat DropCapFormat	[ OPTIONAL ] specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted.
boolean DropCapWholeWord	[ OPTIONAL ] specifies if the property `DropCapFormat` is applied to the whole first word.
boolean ParaKeepTogether	[ OPTIONAL ] Setting this property to true prevents page or column breaks between this and the following paragraph.
boolean ParaSplit	[ OPTIONAL ] Setting this property to false prevents the paragraph from getting split into two pages or columns.
short NumberingLevel	[ OPTIONAL ] specifies the numbering level of the paragraph.
::com::sun::star::container::XIndexReplace NumberingRules	[ OPTIONAL ] contains the numbering rules applied to this paragraph.
short NumberingStartValue	[ OPTIONAL ] specifies the start value for numbering if a new numbering starts at this paragraph.
boolean ParaIsNumberingRestart	[ OPTIONAL ] determines if the numbering rules restart, counting at the current paragraph.
string NumberingStyleName	[ OPTIONAL ] specifies the name of the style for the numbering.
byte 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.
byte 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.
::com::sun::star::table::ShadowFormat ParaShadowFormat	[ OPTIONAL ] determines the type, color, and size of the shadow.
::com::sun::star::table::BorderLine LeftBorder	[ OPTIONAL ] contains the left border of the object.
::com::sun::star::table::BorderLine RightBorder	[ OPTIONAL ] contains the right border of the object.
::com::sun::star::table::BorderLine TopBorder	[ OPTIONAL ] contains the top border of the object.
::com::sun::star::table::BorderLine BottomBorder	[ OPTIONAL ] contains the bottom border of the object.
long BorderDistance	[ OPTIONAL ] contains the distance from the border to the object.
long LeftBorderDistance	[ OPTIONAL ] contains the distance from the left border to the object.
long RightBorderDistance	[ OPTIONAL ] contains the distance from the right border to the object.
long TopBorderDistance	[ OPTIONAL ] contains the distance from the top border to the object.
long BottomBorderDistance	[ OPTIONAL ] contains the distance from the bottom border to the object.
BreakType BreakType	[ OPTIONAL ] determins the type of break that is applied at the beginning of the table.
string DropCapCharStyleName	[ OPTIONAL ] specifies the character style name for drop caps.
long ParaFirstLineIndent	[ OPTIONAL ] specifies the indent for the first line.
boolean ParaIsAutoFirstLineIndent	[ OPTIONAL ] determines if the first line should be indented automatically.
boolean ParaIsHyphenation	specifies if automatic hyphenation is applied.
short ParaHyphenationMaxHyphens	[ OPTIONAL ] specifies the maximum number of consecutive hyphens.
short ParaHyphenationMaxLeadingChars	[ OPTIONAL ] specifies the maximum number of characters to remain before the hyphen character (when hyphenation is applied).
short ParaHyphenationMaxTrailingChars	[ OPTIONAL ] specifies the maximum number of characters to remain after the hyphen character (when hyphenation is applied).
short ParaVertAlignment	[ OPTIONAL ] specifies the vertical alignment of a paragraph.
::com::sun::star::container::XNameContainer ParaUserDefinedAttributes	[ OPTIONAL ] this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.
[ maybevoid ] boolean NumberingIsNumber	[ OPTIONAL ] returns false if the paragraph is part of a numbering, but has no numbering label.
[ maybevoid ] boolean ParaIsConnectBorder	[ OPTIONAL ] the property determines if borders set at a paragraph are merged with the next paragraph.
string ListId	[ OPTIONAL ] specifies the id of the list to which the paragraph belongs
short OutlineLevel	[ OPTIONAL ] specifies the outline level to which the paragraph belongs

Properties' Details

ParaAdjust

ParagraphAdjust ParaAdjust; Description determines the adjustment of a paragraph.

ParaLineSpacing

LineSpacing ParaLineSpacing; Usage Restrictions optional Description contains the type of the line spacing of a paragraph.

ParaBackColor

::com::sun::star::util::Color ParaBackColor; Usage Restrictions optional Description contains the paragraph background color.

ParaBackTransparent

boolean ParaBackTransparent; Usage Restrictions optional Description This value is true if the paragraph background color is set to transparent.

ParaBackGraphicURL

string ParaBackGraphicURL; Usage Restrictions optional Description contains the value of a link for the background graphic of a paragraph.

ParaBackGraphicFilter

string ParaBackGraphicFilter; Usage Restrictions optional Description contains the name of the graphic filter for the background graphic of a paragraph.

ParaBackGraphicLocation

GraphicLocation ParaBackGraphicLocation; Usage Restrictions 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; Usage Restrictions 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; Usage Restrictions optional Description determines if the paragraph is included in the line numbering.

ParaLineNumberStartValue

long ParaLineNumberStartValue; Usage Restrictions optional Description contains the start value for the line numbering.

PageDescName

string PageDescName; Usage Restrictions 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; Usage Restrictions 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; Usage Restrictions 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; Usage Restrictions optional Description specifies the positions and kinds of thei tab stops within this paragraph.

ParaStyleName

string ParaStyleName; Usage Restrictions optional Description contains the name of the current paragraph style.

PageStyleName

[ readonly maybevoid ] string PageStyleName; Usage Restrictions optional Description contains the name of the current page style.

DropCapFormat

DropCapFormat DropCapFormat; Usage Restrictions optional Description specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted.

DropCapWholeWord

boolean DropCapWholeWord; Usage Restrictions optional Description specifies if the property `DropCapFormat` is applied to the whole first word.

ParaKeepTogether

boolean ParaKeepTogether; Usage Restrictions 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; Usage Restrictions optional Description Setting this property to false prevents the paragraph from getting split into two pages or columns.

NumberingLevel

short NumberingLevel; Usage Restrictions optional Description specifies the numbering level of the paragraph.

NumberingRules

::com::sun::star::container::XIndexReplace NumberingRules; Usage Restrictions optional Description contains the numbering rules applied to this paragraph.

NumberingStartValue

short NumberingStartValue; Usage Restrictions optional Description specifies the start value for numbering if a new numbering starts at this paragraph.

ParaIsNumberingRestart

boolean ParaIsNumberingRestart; Usage Restrictions optional Description determines if the numbering rules restart, counting at the current paragraph.

NumberingStyleName

string NumberingStyleName; Usage Restrictions 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; Usage Restrictions 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; Usage Restrictions 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; Usage Restrictions 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; Usage Restrictions optional Description contains the left border of the object.

RightBorder

::com::sun::star::table::BorderLine RightBorder; Usage Restrictions optional Description contains the right border of the object.

TopBorder

::com::sun::star::table::BorderLine TopBorder; Usage Restrictions optional Description contains the top border of the object.

BottomBorder

::com::sun::star::table::BorderLine BottomBorder; Usage Restrictions optional Description contains the bottom border of the object.

BorderDistance

long BorderDistance; Usage Restrictions optional Description contains the distance from the border to the object.

LeftBorderDistance

long LeftBorderDistance; Usage Restrictions optional Description contains the distance from the left border to the object.

RightBorderDistance

long RightBorderDistance; Usage Restrictions optional Description contains the distance from the right border to the object.

TopBorderDistance

long TopBorderDistance; Usage Restrictions optional Description contains the distance from the top border to the object.

BottomBorderDistance

long BottomBorderDistance; Usage Restrictions optional Description contains the distance from the bottom border to the object.

BreakType

BreakType BreakType; Usage Restrictions 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; Usage Restrictions optional Description specifies the character style name for drop caps.

ParaFirstLineIndent

long ParaFirstLineIndent; Usage Restrictions optional Description specifies the indent for the first line.

ParaIsAutoFirstLineIndent

boolean ParaIsAutoFirstLineIndent; Usage Restrictions optional Description determines if the first line should be indented automatically.

ParaIsHyphenation

boolean ParaIsHyphenation; Description specifies if automatic hyphenation is applied.

ParaHyphenationMaxHyphens

short ParaHyphenationMaxHyphens; Usage Restrictions optional Description specifies the maximum number of consecutive hyphens.

ParaHyphenationMaxLeadingChars

short ParaHyphenationMaxLeadingChars; Usage Restrictions optional Description specifies the maximum number of characters to remain before the hyphen character (when hyphenation is applied).

ParaHyphenationMaxTrailingChars

short ParaHyphenationMaxTrailingChars; Usage Restrictions optional Description specifies the maximum number of characters to remain after the hyphen character (when hyphenation is applied).

ParaVertAlignment

short ParaVertAlignment; Usage Restrictions optional Description specifies the vertical alignment of a paragraph. See also ::com::sun::star::text::ParagraphVertAlign

ParaUserDefinedAttributes

::com::sun::star::container::XNameContainer ParaUserDefinedAttributes; Usage Restrictions 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

NumberingIsNumber

[ maybevoid ] boolean NumberingIsNumber; Usage Restrictions optional Description returns false if the paragraph is part of a numbering, but has no numbering label. A paragraph is part of a numbering, if a style for a numbering is set - see NumberingStyleName. If the paragraph is not part of a numbering the property is void.

ParaIsConnectBorder

[ maybevoid ] boolean ParaIsConnectBorder; Usage Restrictions optional Description the property determines if borders set at a paragraph are merged with the next paragraph. Borders are only merged if they are identical.

ListId

string ListId; Usage Restrictions optional Description specifies the id of the list to which the paragraph belongs

OutlineLevel

short OutlineLevel; Usage Restrictions optional Description specifies the outline level to which the paragraph belongs Since OOo 3.1 Value 0 indicates that the paragraph belongs to the body text. Values [1..10] indicates that the paragraph belongs to the corresponding outline level.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous