LibreOffice
LibreOffice 6.4 SDK API Reference
Public Types | Exported Interfaces | Public Attributes | List of all members
CellProperties Service Referencepublished

contains the properties of a table cell. More...

import"CellProperties.idl";

Inheritance diagram for CellProperties:
XPropertySet XInterface SheetCellRanges TableCellStyle Cell CellRange Cell SheetCell SheetCellRange SheetCellCursor Spreadsheet

Public Types

typedef sequence< com::sun::star::beans::PropertyValueCellInteropGrabBag
 Grab bag of cell properties, used as a string-any map for interim interop purposes. More...
 

Exported Interfaces

interface com::sun::star::beans::XPropertySet
 published service PropertySet More...
 

Public Attributes

string CellStyle
 contains the name of the style of the cell. More...
 
com::sun::star::util::Color CellBackColor
 contains the cell background color. More...
 
boolean IsCellBackgroundTransparent
 is TRUE, if the cell background is transparent. More...
 
com::sun::star::table::CellHoriJustify HoriJustify
 contains the horizontal alignment of the cell contents. More...
 
long VertJustify
 contains the vertical alignment of the cell contents. More...
 
boolean IsTextWrapped
 is TRUE, if text in the cells will be wrapped automatically at the right border. More...
 
short ParaIndent
 defines the indentation of the cell contents (in 1/100 mm). More...
 
com::sun::star::table::CellOrientation Orientation
 contains the orientation of the cell contents. More...
 
long RotateAngle
 defines how much the content of cells is rotated (in 1/100 degrees). More...
 
long RotateReference
 defines at which edge rotated cells are aligned. More...
 
boolean AsianVerticalMode
 selects Asian character orientation in vertical orientation. More...
 
com::sun::star::table::TableBorder TableBorder
 contains a description of the cell or cell range border. More...
 
com::sun::star::table::BorderLine TopBorder
 contains a description of the top border line of each cell. More...
 
com::sun::star::table::BorderLine BottomBorder
 contains a description of the bottom border line of each cell. More...
 
com::sun::star::table::BorderLine LeftBorder
 contains a description of the left border line of each cell. More...
 
com::sun::star::table::BorderLine RightBorder
 contains a description of the right border line of each cell. More...
 
long NumberFormat
 contains the index of the number format that is used in the cells. More...
 
com::sun::star::table::ShadowFormat ShadowFormat
 contains a description of the shadow. More...
 
com::sun::star::util::CellProtection CellProtection
 contains a description of the cell protection. More...
 
com::sun::star::container::XNameContainer UserDefinedAttributes
 stores additional attributes. More...
 
com::sun::star::table::BorderLine DiagonalTLBR
 contains a description of the top left to bottom right diagonal line of each cell. More...
 
com::sun::star::table::BorderLine DiagonalBLTR
 contains a description of the bottom left to top right diagonal line of each cell. More...
 
boolean ShrinkToFit
 is TRUE, if the cell content will be shrunk to fit in the cell. More...
 
com::sun::star::table::TableBorder2 TableBorder2
 contains a description of the cell or cell range border. More...
 
com::sun::star::table::BorderLine2 TopBorder2
 contains a description of the top border line of each cell. More...
 
com::sun::star::table::BorderLine2 BottomBorder2
 contains a description of the bottom border line of each cell. More...
 
com::sun::star::table::BorderLine2 LeftBorder2
 contains a description of the left border line of each cell. More...
 
com::sun::star::table::BorderLine2 RightBorder2
 contains a description of the right border line of each cell. More...
 
com::sun::star::table::BorderLine2 DiagonalTLBR2
 contains a description of the top left to bottom right diagonal line of each cell. More...
 
com::sun::star::table::BorderLine2 DiagonalBLTR2
 contains a description of the bottom left to top right diagonal line of each cell. 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

contains the properties of a table cell.

See also
com::sun::star::table::Cell
com::sun::star::table::CellRange

Member Typedef Documentation

◆ CellInteropGrabBag

Grab bag of cell properties, used as a string-any map for interim interop purposes.

Since
LibreOffice 4.3

This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

Exported Interfaces

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

published service PropertySet

provides access to the properties.

Member Data Documentation

◆ AsianVerticalMode

boolean AsianVerticalMode
optionalproperty

selects Asian character orientation in vertical orientation.

If the CellProperties::Orientation property is CellOrientation::STACKED, in Asian mode only Asian characters are printed in horizontal orientation instead of all characters. For other values of CellProperties::Orientation, this value is not used.

◆ BottomBorder

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

contains a description of the bottom border line of each cell.

◆ BottomBorder2

com::sun::star::table::BorderLine2 BottomBorder2
optionalproperty

contains a description of the bottom border line of each cell.

Preferred over BorderLine BottomBorder.

Since
LibreOffice 3.6

◆ CellBackColor

com::sun::star::util::Color CellBackColor
property

contains the cell background color.

◆ CellProtection

com::sun::star::util::CellProtection CellProtection
property

contains a description of the cell protection.

Cell protection is active only if the sheet is protected.

◆ CellStyle

string CellStyle
optionalproperty

contains the name of the style of the cell.

◆ DiagonalBLTR

com::sun::star::table::BorderLine DiagonalBLTR
optionalproperty

contains a description of the bottom left to top right diagonal line of each cell.

◆ DiagonalBLTR2

com::sun::star::table::BorderLine2 DiagonalBLTR2
optionalproperty

contains a description of the bottom left to top right diagonal line of each cell.

Preferred over BorderLine DiagonalBLTR.

Since
LibreOffice 3.6

◆ DiagonalTLBR

com::sun::star::table::BorderLine DiagonalTLBR
optionalproperty

contains a description of the top left to bottom right diagonal line of each cell.

◆ DiagonalTLBR2

com::sun::star::table::BorderLine2 DiagonalTLBR2
optionalproperty

contains a description of the top left to bottom right diagonal line of each cell.

Preferred over BorderLine DiagonalTLBR.

Since
LibreOffice 3.6

◆ HoriJustify

contains the horizontal alignment of the cell contents.

◆ IsCellBackgroundTransparent

boolean IsCellBackgroundTransparent
property

is TRUE, if the cell background is transparent.

In this case the CellProperties::CellBackColor value is not used.

◆ IsTextWrapped

boolean IsTextWrapped
property

is TRUE, if text in the cells will be wrapped automatically at the right border.

◆ LeftBorder

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

contains a description of the left border line of each cell.

◆ LeftBorder2

com::sun::star::table::BorderLine2 LeftBorder2
optionalproperty

contains a description of the left border line of each cell.

Preferred over BorderLine LeftBorder.

Since
LibreOffice 3.6

◆ NumberFormat

long NumberFormat
property

contains the index of the number format that is used in the cells.

The proper value can be determined by using the com::sun::star::util::NumberFormatter interface of the document.

◆ Orientation

contains the orientation of the cell contents.

If the CellProperties::RotateAngle property is non-zero, this value is not used.

◆ ParaIndent

short ParaIndent
property

defines the indentation of the cell contents (in 1/100 mm).

◆ RightBorder

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

contains a description of the right border line of each cell.

◆ RightBorder2

com::sun::star::table::BorderLine2 RightBorder2
optionalproperty

contains a description of the right border line of each cell.

Preferred over BorderLine RightBorder.

Since
LibreOffice 3.6

◆ RotateAngle

long RotateAngle
property

defines how much the content of cells is rotated (in 1/100 degrees).

◆ RotateReference

long RotateReference
property

defines at which edge rotated cells are aligned.

changed from com::sun::star::table::CellVertJustify to long in LibO 3.5

See also
com::sun::star::table::CellVertJustify2

◆ ShadowFormat

contains a description of the shadow.

◆ ShrinkToFit

boolean ShrinkToFit
optionalproperty

is TRUE, if the cell content will be shrunk to fit in the cell.

◆ TableBorder

contains a description of the cell or cell range border.

If used with a cell range, the top, left, right, and bottom lines are at the edges of the entire range, not at the edges of the individual cell.

◆ TableBorder2

contains a description of the cell or cell range border.

Preferred over TableBorder TableBorder.

If used with a cell range, the top, left, right, and bottom lines are at the edges of the entire range, not at the edges of the individual cell.

Since
LibreOffice 3.6

◆ TopBorder

contains a description of the top border line of each cell.

◆ TopBorder2

com::sun::star::table::BorderLine2 TopBorder2
optionalproperty

contains a description of the top border line of each cell.

Preferred over BorderLine TopBorder.

Since
LibreOffice 3.6

◆ UserDefinedAttributes

com::sun::star::container::XNameContainer UserDefinedAttributes
optionalproperty

stores additional attributes.

This property is used i.e. by the XML filters to load and restore unknown attributes.

◆ VertJustify

long VertJustify
property

contains the vertical alignment of the cell contents.

changed from com::sun::star::table::CellVertJustify to long in LibO 3.5

See also
com::sun::star::table::CellVertJustify2

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