Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: table ::

service CellProperties

Description
contains the properties of a table cell.
See also
com::sun::star::table::Cell
See also
com::sun::star::table::CellRange


Exported Interfaces

com::sun::star::beans::XPropertySet
Description
provides access to the properties.

Properties' Summary

CellStyle contains the name of the style of the cell.
CellBackColor contains the cell background color.
IsCellBackgroundTransparent is true , if the cell background is transparent.
HoriJustify contains the horizontal alignment of the cell contents.
VertJustify contains the vertical alignment of the cell contents.
IsTextWrapped is true , if text in the cells will be wrapped automatically at the right border.
ParaIndent defines the indentation of the cell contents (in 1/100 mm).
Orientation contains the orientation of the cell contents.
RotateAngle defines how much the content of cells is rotated (in 1/100 degrees).
RotateReference defines at which edge rotated cells are aligned.
AsianVerticalMode [ OPTIONAL ]
selects Asian character orientation in vertical orientation.
TableBorder contains a description of the cell or cell range border.
TopBorder contains a description of the top border line of each cell.
BottomBorder contains a description of the bottom border line of each cell.
LeftBorder contains a description of the left border line of each cell.
RightBorder contains a description of the right border line of each cell.
NumberFormat contains the index of the number format that is used in the cells.
ShadowFormat contains a description of the shadow.
CellProtection contains a description of the cell protection.
UserDefinedAttributes [ OPTIONAL ]
stores additional attributes.

Properties' Details

CellStyle
 
string CellStyle;
Description
contains the name of the style of the cell.
CellBackColor
 
long CellBackColor;
Description
contains the cell background color.
IsCellBackgroundTransparent
 
boolean IsCellBackgroundTransparent;
Description
is true , if the cell background is transparent.

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

HoriJustify
 
com::sun::star::table::CellHoriJustify HoriJustify;
Description
contains the horizontal alignment of the cell contents.
VertJustify
 
com::sun::star::table::CellVertJustify VertJustify;
Description
contains the vertical alignment of the cell contents.
IsTextWrapped
 
boolean IsTextWrapped;
Description
is true , if text in the cells will be wrapped automatically at the right border.
ParaIndent
 
short ParaIndent;
Description
defines the indentation of the cell contents (in 1/100 mm).
Orientation
 
com::sun::star::table::CellOrientation Orientation;
Description
contains the orientation of the cell contents.

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

RotateAngle
 
long RotateAngle;
Description
defines how much the content of cells is rotated (in 1/100 degrees).
RotateReference
 
com::sun::star::table::CellVertJustify RotateReference;
Description
defines at which edge rotated cells are aligned.
AsianVerticalMode
 
boolean AsianVerticalMode;
[ OPTIONAL ]
Description
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.

TableBorder
 
com::sun::star::table::TableBorder TableBorder;
Description
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.

TopBorder
 
com::sun::star::table::BorderLine TopBorder;
Description
contains a description of the top border line of each cell.
BottomBorder
 
com::sun::star::table::BorderLine BottomBorder;
Description
contains a description of the bottom border line of each cell.
LeftBorder
 
com::sun::star::table::BorderLine LeftBorder;
Description
contains a description of the left border line of each cell.
RightBorder
 
com::sun::star::table::BorderLine RightBorder;
Description
contains a description of the right border line of each cell.
NumberFormat
 
long NumberFormat;
Description
contains the index of the number format that is used in the cells.

The proper value can be determined by using the NumberFormatter interface of the document.

ShadowFormat
 
com::sun::star::table::ShadowFormat ShadowFormat;
Description
contains a description of the shadow.
CellProtection
 
com::sun::star::util::CellProtection CellProtection;
Description
contains a description of the cell protection.

Cell protection is active only if the sheet is protected.

UserDefinedAttributes
 
com::sun::star::container::XNameContainer UserDefinedAttributes;
[ OPTIONAL ]
Description
stores additional attributes.

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


Top of Page