LibreOffice
LibreOffice 7.4 SDK API Reference
Included Services | Exported Interfaces | List of all members
Paragraph Service Referencepublished

is a piece of text which can take its own paragraph-specific attributes (technically, properties). More...

import"Paragraph.idl";

Inheritance diagram for Paragraph:
XTolerantMultiPropertySet XEnumerationAccess XPropertyState XPropertySet TextContent TextTable CharacterPropertiesComplex CharacterPropertiesAsian CharacterProperties ParagraphPropertiesComplex ParagraphPropertiesAsian ParagraphProperties

Included Services

service com::sun::star::style::ParagraphProperties
 This service is present when the paragraph object refers to a text range. More...
 
service com::sun::star::style::ParagraphPropertiesAsian
 This service is present when the paragraph object refers to a text range. More...
 
service com::sun::star::style::ParagraphPropertiesComplex
 This service is present when the paragraph object refers to a text range. More...
 
service com::sun::star::style::CharacterProperties
 This service is present when the paragraph object refers to a text range. More...
 
service com::sun::star::style::CharacterPropertiesAsian
 This service is present when the paragraph object refers to a text range. More...
 
service com::sun::star::style::CharacterPropertiesComplex
 This service is present when the paragraph object refers to a text range. More...
 
service com::sun::star::text::TextTable
 This service is present when the paragraph object refers to a text table. More...
 
service com::sun::star::text::TextContent
 
- Included Services inherited from TextTable
service com::sun::star::text::TextContent
 
service com::sun::star::xml::UserDefinedAttributesSupplier
 

Exported Interfaces

interface com::sun::star::beans::XPropertySet
 This interface gives access to the properties of the paragraph itself (or its style sheet). More...
 
interface com::sun::star::beans::XPropertyState
 This interface gives access to the state of the property values in these properties. More...
 
interface com::sun::star::container::XEnumerationAccess
 This interface enumerates the text portions of this paragraph. More...
 
interface ::com::sun::star::beans::XTolerantMultiPropertySet
 gives access to a sequence of properties. More...
 
- Exported Interfaces inherited from TextTable
interface com::sun::star::text::XTextTable
 
interface com::sun::star::container::XNamed
 
interface com::sun::star::table::XCellRange
 
interface com::sun::star::chart::XChartDataArray
 
interface com::sun::star::table::XAutoFormattable
 
interface com::sun::star::util::XSortable
 
interface com::sun::star::sheet::XCellRangeData
 
- Exported Interfaces inherited from TextContent
interface com::sun::star::text::XTextContent
 This interface is used for the attachment of this text content to the surrounding text. More...
 

Additional Inherited Members

- Public Types inherited from TextContent
typedef sequence< com::sun::star::text::TextContentAnchorTypeAnchorTypes
 contains the anchor type of the text content. More...
 
- Public Member Functions inherited from XTextContent
void attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException )
 is called when this object gets embedded in a text. More...
 
com::sun::star::text::XTextRange getAnchor ()
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value. More...
 
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- Public Member Functions inherited from XEnumerationAccess
com::sun::star::container::XEnumeration createEnumeration ()
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Public Attributes inherited from TextContent
com::sun::star::text::TextContentAnchorType AnchorType
 specifies how the text content is attached to its surrounding Text. More...
 
com::sun::star::text::WrapTextMode TextWrap
 specifies if the text content is a shape and how the text is wrapped around the shape. More...
 
- Protected Types inherited from ParagraphProperties
typedef sequence< com::sun::star::beans::PropertyValueParaInteropGrabBag
 Grab bag of paragraph properties, used as a string-any map for interim interop purposes. More...
 
typedef sequence< com::sun::star::style::TabStopParaTabStops
 specifies the positions and kinds of the tab stops within this paragraph. More...
 
- Protected Types inherited from CharacterProperties
typedef sequence< string > CharStyleNames
 This optional property specifies the names of the all styles applied to the font. More...
 
typedef sequence< com::sun::star::beans::PropertyValueCharInteropGrabBag
 Grab bag of character properties, used as a string-any map for interim interop purposes. More...
 
- Protected Types inherited from TextTable
typedef sequence< com::sun::star::text::TableColumnSeparatorTableColumnSeparators
 contains the column description of the table. More...
 
typedef sequence< com::sun::star::beans::PropertyValueTableInteropGrabBag
 Grab bag of table properties, used as a string-any map for interim interop purposes. More...
 
- Protected Types inherited from TextContent
typedef sequence< com::sun::star::text::TextContentAnchorTypeAnchorTypes
 contains the anchor type of the text content. More...
 
- Protected Member Functions inherited from XTextContent
void attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException )
 is called when this object gets embedded in a text. More...
 
com::sun::star::text::XTextRange getAnchor ()
 
- Protected Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Protected Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Protected Member Functions inherited from XTextTable
void initialize ([in] long nRows, [in] long nColumns)
 determines the numbers of rows and columns of the text table. More...
 
com::sun::star::table::XTableRows getRows ()
 
com::sun::star::table::XTableColumns getColumns ()
 
com::sun::star::table::XCell getCellByName ([in] string aCellName)
 
sequence< string > getCellNames ()
 
com::sun::star::text::XTextTableCursor createCursorByCellName ([in] string aCellName)
 creates a text table cursor and returns the XTextTableCursor interface. More...
 
- Protected Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 
- Protected Member Functions inherited from XCellRange
com::sun::star::table::XCell getCellByPosition ([in] long nColumn, [in] long nRow) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a single cell within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByPosition ([in] long nLeft, [in] long nTop, [in] long nRight, [in] long nBottom) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a sub-range of cells within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByName ([in] string aRange)
 Returns a sub-range of cells within the range. More...
 
- Protected Member Functions inherited from XChartDataArray
sequence< sequence< double > > getData ()
 retrieves the numerical data as a nested sequence of values. More...
 
void setData ([in] sequence< sequence< double > > aData)
 sets the chart data as an array of numbers. More...
 
sequence< string > getRowDescriptions ()
 retrieves the description texts for all rows. More...
 
void setRowDescriptions ([in] sequence< string > aRowDescriptions)
 sets the description texts for all rows. More...
 
sequence< string > getColumnDescriptions ()
 retrieves the description texts for all columns. More...
 
void setColumnDescriptions ([in] sequence< string > aColumnDescriptions)
 sets the description texts for all columns. More...
 
- Protected Member Functions inherited from XChartData
void addChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 allows a component supporting the XChartDataChangeEventListener interface to register as listener. More...
 
void removeChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 removes a previously registered listener. More...
 
double getNotANumber ()
 
boolean isNotANumber ([in] double nNumber)
 checks whether the value given is equal to the indicator value for a missing value. More...
 
- Protected Member Functions inherited from XAutoFormattable
void autoFormat ([in] string aName) raises ( com::sun::star::lang::IllegalArgumentException )
 applies an AutoFormat to the cell range of the current context. More...
 
- Protected Member Functions inherited from XSortable
sequence< com::sun::star::beans::PropertyValuecreateSortDescriptor ()
 
void sort ([in] sequence< com::sun::star::beans::PropertyValue > xDescriptor)
 sorts the contents of the object according to the specified properties. More...
 
- Protected Member Functions inherited from XCellRangeData
sequence< sequence< any > > getDataArray ()
 gets an array from the contents of the cell range. More...
 
void setDataArray ([in] sequence< sequence< any > > aArray)
 fills the cell range with values from an array. More...
 
- Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value. More...
 
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- Protected Member Functions inherited from XEnumerationAccess
com::sun::star::container::XEnumeration createEnumeration ()
 
- Protected Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- Protected Member Functions inherited from XTolerantMultiPropertySet
sequence< com::sun::star::beans::SetPropertyTolerantFailedsetPropertyValuesTolerant ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::lang::IllegalArgumentException )
 sets the values to the properties with the specified names. More...
 
sequence< com::sun::star::beans::GetPropertyTolerantResultgetPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve the values of the specified properties More...
 
sequence< com::sun::star::beans::GetDirectPropertyTolerantResultgetDirectPropertyValuesTolerant ([in] sequence< string > aPropertyNames)
 retrieve only those values of the specified properties which are direct values. More...
 
- Protected Attributes inherited from ParagraphProperties
com::sun::star::style::ParagraphAdjust ParaAdjust
 determines the adjustment of a paragraph. More...
 
com::sun::star::style::LineSpacing ParaLineSpacing
 contains the type of the line spacing of a paragraph. More...
 
com::sun::star::util::Color ParaBackColor
 contains the paragraph background color. More...
 
boolean ParaBackTransparent
 This value is TRUE if the paragraph background color is set to transparent. More...
 
string ParaBackGraphicURL
 contains the value of a link for the background graphic of a paragraph. More...
 
string ParaBackGraphicFilter
 contains the name of the graphic filter for the background graphic of a paragraph. More...
 
com::sun::star::style::GraphicLocation ParaBackGraphicLocation
 contains the value for the position of a background graphic. More...
 
short ParaLastLineAdjust
 determines the adjustment of the last line. More...
 
boolean ParaExpandSingleWord
 determines if single words are stretched. More...
 
long ParaLeftMargin
 determines the left margin of the paragraph in 100th mm. More...
 
long ParaRightMargin
 determines the right margin of the paragraph in 100th mm. More...
 
long ParaTopMargin
 determines the top margin of the paragraph in 100th mm. More...
 
long ParaBottomMargin
 determines the bottom margin of the paragraph in 100th mm. More...
 
boolean ParaContextMargin
 determines if contextual spacing is used. More...
 
boolean ParaLineNumberCount
 determines if the paragraph is included in the line numbering. More...
 
long ParaLineNumberStartValue
 contains the start value for the line numbering. More...
 
string 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. More...
 
short PageNumberOffset
 If a page break property is set at a paragraph, this property contains the new value for the page number. More...
 
boolean ParaRegisterModeActive
 determines if the register mode is applied to a paragraph. More...
 
string ParaStyleName
 contains the name of the current paragraph style. More...
 
string PageStyleName
 contains the name of the current page style. More...
 
com::sun::star::style::DropCapFormat DropCapFormat
 specifies whether the first characters of the paragraph are displayed in capital letters and how they are formatted. More...
 
boolean DropCapWholeWord
 specifies if the property DropCapFormat is applied to the whole first word. More...
 
boolean ParaKeepTogether
 Setting this property to TRUE prevents page or column breaks between this and the following paragraph. More...
 
boolean ParaSplit
 Setting this property to FALSE prevents the paragraph from getting split into two pages or columns. More...
 
short NumberingLevel
 specifies the numbering level of the paragraph. More...
 
com::sun::star::container::XIndexReplace NumberingRules
 contains the numbering rules applied to this paragraph. More...
 
short NumberingStartValue
 specifies the start value for numbering if a new numbering starts at this paragraph. More...
 
boolean ParaIsNumberingRestart
 determines if the numbering rules restart, counting at the current paragraph. More...
 
string NumberingStyleName
 specifies the name of the style for the numbering. More...
 
byte 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. More...
 
byte 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. More...
 
com::sun::star::table::ShadowFormat ParaShadowFormat
 determines the type, color, and size of the shadow. More...
 
com::sun::star::table::BorderLine LeftBorder
 contains the left border of the object. More...
 
com::sun::star::table::BorderLine RightBorder
 contains the right border of the object. More...
 
com::sun::star::table::BorderLine TopBorder
 contains the top border of the object. More...
 
com::sun::star::table::BorderLine BottomBorder
 contains the bottom border of the object. More...
 
long BorderDistance
 contains the distance from the border to the object. More...
 
long LeftBorderDistance
 contains the distance from the left border to the object. More...
 
long RightBorderDistance
 contains the distance from the right border to the object. More...
 
long TopBorderDistance
 contains the distance from the top border to the object. More...
 
long BottomBorderDistance
 contains the distance from the bottom border to the object. More...
 
com::sun::star::style::BreakType BreakType
 determines the type of break that is applied at the beginning of the table. More...
 
string DropCapCharStyleName
 specifies the character style name for drop caps. More...
 
long ParaFirstLineIndent
 specifies the indent for the first line. More...
 
boolean ParaIsAutoFirstLineIndent
 determines if the first line should be indented automatically. More...
 
boolean ParaIsHyphenation
 specifies if automatic hyphenation is applied. More...
 
short ParaHyphenationMaxHyphens
 specifies the maximum number of consecutive hyphens. More...
 
short ParaHyphenationMaxLeadingChars
 specifies the minimum number of characters to remain before the hyphen character (when hyphenation is applied). More...
 
short ParaHyphenationMaxTrailingChars
 specifies the minimum number of characters to remain after the hyphen character (when hyphenation is applied). More...
 
short ParaVertAlignment
 specifies the vertical alignment of a paragraph. More...
 
com::sun::star::container::XNameContainer ParaUserDefinedAttributes
 this property stores xml attributes. More...
 
boolean NumberingIsNumber
 returns FALSE if the paragraph is part of a numbering, but has no numbering label. More...
 
boolean ParaIsConnectBorder
 the property determines if borders set at a paragraph are merged with the next paragraph. More...
 
string ListId
 specifies the id of the list to which the paragraph belongs More...
 
short OutlineLevel
 specifies the outline level to which the paragraph belongs More...
 
com::sun::star::graphic::XGraphic ParaBackGraphic
 contains the graphic for the background of a paragraph. More...
 
boolean ContinueingPreviousSubTree
 specifies that a child node of a parent node that is not counted is continuing the numbering of parent's previous node's sub tree. More...
 
string ListLabelString
 allows reading the generated numbering list label. More...
 
boolean ParaHyphenationNoCaps
 Specifies whether words written in CAPS will be hyphenated. More...
 
boolean ParaHyphenationNoLastWord
 Specifies whether last word of paragraph will be hyphenated. More...
 
short ParaHyphenationMinWordLength
 specifies the minimum word length in characters, when hyphenation is applied. More...
 
long ParaHyphenationZone
 specifies the hyphenation zone, i.e. More...
 
- Protected Attributes inherited from ParagraphPropertiesAsian
boolean ParaIsHangingPunctuation
 determines if hanging punctuation is allowed. More...
 
boolean ParaIsCharacterDistance
 determines if a distance between Asian text, western text or complex text is set. More...
 
boolean ParaIsForbiddenRules
 determines if the rules for forbidden characters at the start or end of text lines are considered. More...
 
- Protected Attributes inherited from ParagraphPropertiesComplex
short WritingMode
 contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants More...
 
- Protected Attributes inherited from CharacterProperties
string CharFontName
 This property specifies the name of the font style. More...
 
string CharFontStyleName
 This property contains the name of the font style. More...
 
short CharFontFamily
 This property contains font family. More...
 
short CharFontCharSet
 This property contains the text encoding of the font. More...
 
short CharFontPitch
 This property contains the font pitch. More...
 
com::sun::star::util::Color CharColor
 This property contains the value of the text color. More...
 
short CharEscapement
 specifies the percentage by which to raise/lower superscript/subscript characters. More...
 
float CharHeight
 This value contains the height of the characters in point. More...
 
short CharUnderline
 This property contains the value for the character underline. More...
 
float CharWeight
 This property contains the value of the font weight. More...
 
com::sun::star::awt::FontSlant CharPosture
 This property contains the value of the posture of the document. More...
 
boolean CharAutoKerning
 This optional property determines whether the kerning tables from the current font are used. More...
 
com::sun::star::util::Color CharBackColor
 This optional property contains the text background color. More...
 
long CharShadingValue
 This optional property contains the text shading value. More...
 
boolean CharBackTransparent
 This property determines if the text background color is set to transparent. More...
 
short CharCaseMap
 This optional property contains the value of the case-mapping of the text for formatting and displaying. More...
 
boolean CharCrossedOut
 This property is TRUE if the characters are crossed out. More...
 
boolean CharFlash
 If this optional property is TRUE, then the characters are flashing. More...
 
short CharStrikeout
 This property determines the type of the strike out of the character. More...
 
boolean CharWordMode
 If this property is TRUE, the underline and strike-through properties are not applied to white spaces. More...
 
short CharKerning
 This optional property contains the value of the kerning of the characters. More...
 
com::sun::star::lang::Locale CharLocale
 This property contains the value of the locale. More...
 
boolean CharKeepTogether
 This optional property marks a range of characters to prevent it from being broken into two lines. More...
 
boolean CharNoLineBreak
 This optional property marks a range of characters to ignore a line break in this area. More...
 
boolean CharShadowed
 This optional property specifies if the characters are formatted and displayed with a shadow effect. More...
 
short CharFontType
 This optional property specifies the fundamental technology of the font. More...
 
string CharStyleName
 This optional property specifies the name of the style of the font. More...
 
boolean CharContoured
 This optional property specifies if the characters are formatted and displayed with a contour effect. More...
 
boolean CharCombineIsOn
 This optional property determines whether text is formatted in two lines. More...
 
string CharCombinePrefix
 This optional property contains the prefix (usually parenthesis) before text that is formatted in two lines. More...
 
string CharCombineSuffix
 This optional property contains the suffix (usually parenthesis) after text that is formatted in two lines. More...
 
short CharEmphasis
 This optional property contains the font emphasis value. More...
 
short CharRelief
 This optional property contains the relief style of the characters. More...
 
string RubyText
 This optional property contains the text that is set as ruby. More...
 
short RubyAdjust
 This optional property determines the adjustment of the ruby . More...
 
string RubyCharStyleName
 This optional property contains the name of the character style that is applied to RubyText. More...
 
boolean RubyIsAbove
 This optional property determines whether the ruby text is printed above/left or below/right of the text. More...
 
short CharRotation
 This optional property determines the rotation of a character in tenths of a degree. More...
 
boolean CharRotationIsFitToLine
 This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height. More...
 
short CharScaleWidth
 This optional property determines the percentage value for scaling the width of characters. More...
 
string HyperLinkURL
 This optional property contains the URL of a hyperlink. More...
 
string HyperLinkTarget
 This optional property contains the name of the target for a hyperlink. More...
 
string HyperLinkName
 This optional property contains the name of the hyperlink. More...
 
string VisitedCharStyleName
 This optional property contains the character style name for visited hyperlinks. More...
 
string UnvisitedCharStyleName
 This optional property contains the character style name for unvisited hyperlinks. More...
 
byte CharEscapementHeight
 This is the relative height used for subscript or superscript characters in units of percent. More...
 
boolean CharNoHyphenation
 This optional property determines if the word can be hyphenated at the character. More...
 
com::sun::star::util::Color CharUnderlineColor
 This property contains the color of the underline for the characters. More...
 
boolean CharUnderlineHasColor
 This property specifies if the property CharUnderlineColor is used for an underline. More...
 
boolean CharHidden
 If this optional property is TRUE, then the characters are invisible. More...
 
com::sun::star::container::XNameContainer TextUserDefinedAttributes
 This property stores XML attributes. More...
 
com::sun::star::table::BorderLine2 CharLeftBorder
 This property contains the left border of the object. More...
 
com::sun::star::table::BorderLine2 CharRightBorder
 This property contains the right border of the object. More...
 
com::sun::star::table::BorderLine2 CharTopBorder
 This property contains the top border of the object. More...
 
com::sun::star::table::BorderLine2 CharBottomBorder
 This property contains the bottom border of the object. More...
 
long CharBorderDistance
 This property contains the distance from the border to the object. More...
 
long CharLeftBorderDistance
 This property contains the distance from the left border to the object. More...
 
long CharRightBorderDistance
 This property contains the distance from the right border to the object. More...
 
long CharTopBorderDistance
 This property contains the distance from the top border to the object. More...
 
long CharBottomBorderDistance
 This property contains the distance from the bottom border to the object. More...
 
com::sun::star::table::ShadowFormat CharShadowFormat
 Determines the type, color, and width of the shadow. More...
 
com::sun::star::util::Color CharHighlight
 Determines the color of the highlight. More...
 
short RubyPosition
 This optional property determines the position of the ruby . More...
 
short CharTransparence
 This is the transparency of the character text. More...
 
short CharColorTheme
 If available, keeps the color theme index, so that the character can be re-colored easily based on a theme. More...
 
short CharColorTintOrShade
 Tint or shade of the character color. More...
 
- Protected Attributes inherited from CharacterPropertiesAsian
float CharHeightAsian
 This value contains the height of the characters in point. More...
 
float CharWeightAsian
 This property contains the value of the font weight. More...
 
string CharFontNameAsian
 This property specifies the name of the font style. More...
 
string CharFontStyleNameAsian
 This property contains the name of the font style. More...
 
short CharFontFamilyAsian
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetAsian
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchAsian
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureAsian
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleAsian
 contains the value of the locale. More...
 
- Protected Attributes inherited from CharacterPropertiesComplex
float CharHeightComplex
 This value contains the height of the characters in point. More...
 
float CharWeightComplex
 This property contains the value of the font weight. More...
 
string CharFontNameComplex
 This property specifies the name of the font style. More...
 
string CharFontStyleNameComplex
 This property contains the name of the font style. More...
 
short CharFontFamilyComplex
 This property contains font family as specified in com.sun.star.awt.FontFamily . More...
 
short CharFontCharSetComplex
 This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
 
short CharFontPitchComplex
 This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
 
com::sun::star::awt::FontSlant CharPostureComplex
 This property contains the value of the posture of the document. More...
 
com::sun::star::lang::Locale CharLocaleComplex
 contains the value of the locale. More...
 
- Protected Attributes inherited from TextTable
com::sun::star::style::BreakType BreakType
 determines the type of break that is applied at the beginning of the table. More...
 
long LeftMargin
 contains the left margin of the table. More...
 
long RightMargin
 contains the right margin of the table. More...
 
short HoriOrient
 contains the horizontal orientation. More...
 
boolean KeepTogether
 Setting this property to TRUE prevents page or column breaks between this table and the following paragraph or text table. More...
 
boolean Split
 Setting this property to FALSE prevents the table from getting spread on two pages. More...
 
short PageNumberOffset
 If a page break property is set at the table, this property contains the new value for the page number. More...
 
string PageDescName
 If this property is set, it creates a page break before the table and assigns the value as the name of the new page style sheet to use. More...
 
short RelativeWidth
 determines the width of the table relative to its environment. More...
 
boolean IsWidthRelative
 determines if the value of the relative width is valid. More...
 
boolean RepeatHeadline
 determines if the first row of the table is repeated on every new page. More...
 
long HeaderRowCount
 determines the number of rows of the table repeated on every new page. More...
 
com::sun::star::table::ShadowFormat ShadowFormat
 determines the type, color and size of the shadow. More...
 
long TopMargin
 determines the top margin. More...
 
long BottomMargin
 determines the bottom margin. More...
 
boolean BackTransparent
 determines if the background color is transparent. More...
 
long Width
 contains the absolute table width. More...
 
boolean ChartRowAsLabel
 determines if the first row of the table should be treated as axis labels when a chart is to be created. More...
 
boolean ChartColumnAsLabel
 determines if the first column of the table should be treated as axis labels when a chart is to be created. More...
 
com::sun::star::table::TableBorder TableBorder
 contains the description of the table borders. More...
 
short TableColumnRelativeSum
 contains the sum of the column width values used in TableColumnSeparators. More...
 
com::sun::star::util::Color BackColor
 contains the color of the background. More...
 
string BackGraphicURL
 contains the URL for the background graphic. More...
 
string BackGraphicFilter
 contains the name of the file filter for the background graphic. More...
 
com::sun::star::style::GraphicLocation BackGraphicLocation
 determines the position of the background graphic. More...
 
boolean CollapsingBorders
 determines whether borders of neighboring table cells are collapsed into one More...
 
string TableTemplateName
 contains the name of table style used by the table. More...
 
com::sun::star::graphic::XGraphic BackGraphic
 contains the graphic for the background. More...
 
- Protected Attributes inherited from TextContent
com::sun::star::text::TextContentAnchorType AnchorType
 specifies how the text content is attached to its surrounding Text. More...
 
com::sun::star::text::WrapTextMode TextWrap
 specifies if the text content is a shape and how the text is wrapped around the shape. More...
 
- Protected Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer UserDefinedAttributes
 This container holds the AttributeData elements that represent uninterpreted XML attributes. More...
 

Detailed Description

is a piece of text which can take its own paragraph-specific attributes (technically, properties).

Developers Guide
Text Documents - Iterating over Text
Text Documents - Formatting

Exported Interfaces

◆ com::sun::star::style::CharacterProperties

This service is present when the paragraph object refers to a text range.

◆ com::sun::star::style::CharacterPropertiesAsian

This service is present when the paragraph object refers to a text range.

◆ com::sun::star::style::CharacterPropertiesComplex

This service is present when the paragraph object refers to a text range.

◆ com::sun::star::style::ParagraphProperties

This service is present when the paragraph object refers to a text range.

◆ com::sun::star::style::ParagraphPropertiesAsian

This service is present when the paragraph object refers to a text range.

◆ com::sun::star::style::ParagraphPropertiesComplex

This service is present when the paragraph object refers to a text range.

◆ com::sun::star::text::TextContent

◆ com::sun::star::text::TextTable

This service is present when the paragraph object refers to a text table.

Exported Interfaces

◆ ::com::sun::star::beans::XTolerantMultiPropertySet

gives access to a sequence of properties.

Since
OOo 2.0

◆ com::sun::star::beans::XPropertySet

This interface gives access to the properties of the paragraph itself (or its style sheet).

So this interface may show property values which are not valid for any of the text portions of the paragraph, if the text itself has its own style properties set.

◆ com::sun::star::beans::XPropertyState

This interface gives access to the state of the property values in these properties.

So, it is possible to determine if a specific properties value is defined in the paragraph or its style sheet.

◆ com::sun::star::container::XEnumerationAccess

This interface enumerates the text portions of this paragraph.

    <p>A text portion is defined as the largest possible TextRange
    within a paragraph with the same property values and the same bound objects.

    <p>In general this interface is used for exporting into file
    formats.

    @see com::sun::star::text::TextRange@see com::sun::star::text::TextRange

The documentation for this service was generated from the following file: