LibreOffice
LibreOffice 24.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
CellProperties Service Referencepublished

service that holds all cell properties of a text table cell in a text document. More...

import"CellProperties.idl";

Inheritance diagram for CellProperties:
UserDefinedAttributesSupplier XPropertySet XInterface Cell

Included Services

service com::sun::star::xml::UserDefinedAttributesSupplier
 contains user defined attributes. More...
 

Exported Interfaces

interface com::sun::star::beans::XPropertySet
 gives access to the objects properties More...
 

Public Attributes

string CellName
 contains the cell name, see SwXTextTable::getCellByName for more information More...
 
com::sun::star::util::Color BackColor
 contains the background color. More...
 
string BackGraphicURL
 contains the URL to the background graphic. More...
 
string BackGraphicFilter
 contains the name of the graphic filter of the background graphic. More...
 
com::sun::star::style::GraphicLocation BackGraphicLocation
 determines the position of the background graphic. More...
 
long NumberFormat
 contains the number format. More...
 
boolean BackTransparent
 determines whether the background is transparent. More...
 
com::sun::star::table::BorderLine LeftBorder
 contains the left border line. More...
 
com::sun::star::table::BorderLine RightBorder
 contains the right border line. More...
 
com::sun::star::table::BorderLine TopBorder
 contains the top border line. More...
 
com::sun::star::table::BorderLine BottomBorder
 contains the bottom border line. More...
 
long LeftBorderDistance
 contains the distance of the left border. More...
 
long RightBorderDistance
 contains the distance of the right border. More...
 
long TopBorderDistance
 contains the distance of the top border. More...
 
long BottomBorderDistance
 contains the distance of the bottom border. More...
 
com::sun::star::text::XTextSection TextSection
 contains the text section the text table is contained in if there is any. More...
 
boolean IsProtected
 determines whether the cell is write protected or not. More...
 
short VertOrient
 the vertical orientation of the text inside of the table cells in this row. More...
 
com::sun::star::graphic::XGraphic BackGraphic
 contains the graphic object that is displayed as background graphic. More...
 
com::sun::star::text::XText ParentText
 Parent text of this table cell. More...
 
boolean HasTextChangesOnly
 If TRUE, the table cell wasn't deleted or inserted with its tracked cell content. More...
 
- Public Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer UserDefinedAttributes
 This container holds the AttributeData elements that represent uninterpreted XML attributes. More...
 

Additional Inherited Members

- 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 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...
 

Detailed Description

service that holds all cell properties of a text table cell in a text document.

See also
com::sun::star::text::Cell

Exported Interfaces

◆ com::sun::star::xml::UserDefinedAttributesSupplier

contains user defined attributes.

See also
com::sun::star::xml::UserDefinedAttributesSupplier

Exported Interfaces

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

gives access to the objects properties

Member Data Documentation

◆ BackColor

com::sun::star::util::Color BackColor
property

contains the background color.

◆ BackGraphic

com::sun::star::graphic::XGraphic BackGraphic
optionalproperty

contains the graphic object that is displayed as background graphic.

Since
LibreOffice 6.1

◆ BackGraphicFilter

string BackGraphicFilter
property

contains the name of the graphic filter of the background graphic.

◆ BackGraphicLocation

com::sun::star::style::GraphicLocation BackGraphicLocation
property

determines the position of the background graphic.

◆ BackGraphicURL

string BackGraphicURL
property

contains the URL to the background graphic.

Deprecated:
as of LibreOffice 6.1 - use BackGraphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the BackGraphic property.

◆ BackTransparent

boolean BackTransparent
property

determines whether the background is transparent.

◆ BottomBorder

com::sun::star::table::BorderLine BottomBorder
property

contains the bottom border line.

◆ BottomBorderDistance

long BottomBorderDistance
property

contains the distance of the bottom border.

◆ CellName

string CellName
property

contains the cell name, see SwXTextTable::getCellByName for more information

◆ HasTextChangesOnly

boolean HasTextChangesOnly
optionalproperty

If TRUE, the table cell wasn't deleted or inserted with its tracked cell content.

Since
LibreOffice 7.6

◆ IsProtected

boolean IsProtected
property

determines whether the cell is write protected or not.

◆ LeftBorder

com::sun::star::table::BorderLine LeftBorder
property

contains the left border line.

◆ LeftBorderDistance

long LeftBorderDistance
property

contains the distance of the left border.

◆ NumberFormat

long NumberFormat
property

contains the number format.

◆ ParentText

com::sun::star::text::XText ParentText
optionalpropertyreadonly

Parent text of this table cell.

This might be a header text, body text, parent cell, etc.

Since
LibreOffice 6.3

◆ RightBorder

com::sun::star::table::BorderLine RightBorder
property

contains the right border line.

◆ RightBorderDistance

long RightBorderDistance
property

contains the distance of the right border.

◆ TextSection

contains the text section the text table is contained in if there is any.

◆ TopBorder

contains the top border line.

◆ TopBorderDistance

long TopBorderDistance
property

contains the distance of the top border.

◆ VertOrient

short VertOrient
property

the vertical orientation of the text inside of the table cells in this row.

See also
VertOrientation

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