Service CellProperties

Devguide

Index

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

Properties' Details

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

service CellProperties

Description: contains the properties of a table cell.
See also: Cell, CellRange

Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet	provides access to the properties.

Properties' Summary
string CellStyle	[ OPTIONAL ] contains the name of the style of the cell.
::com::sun::star::util::Color CellBackColor	contains the cell background color.
boolean IsCellBackgroundTransparent	is true, if the cell background is transparent.
CellHoriJustify HoriJustify	contains the horizontal alignment of the cell contents.
CellVertJustify VertJustify	contains the vertical alignment of the cell contents.
boolean IsTextWrapped	is true, if text in the cells will be wrapped automatically at the right border.
short ParaIndent	defines the indentation of the cell contents (in 1/100 mm).
CellOrientation Orientation	contains the orientation of the cell contents.
long RotateAngle	defines how much the content of cells is rotated (in 1/100 degrees).
CellVertJustify RotateReference	defines at which edge rotated cells are aligned.
boolean AsianVerticalMode	[ OPTIONAL ] selects Asian character orientation in vertical orientation.
TableBorder TableBorder	contains a description of the cell or cell range border.
BorderLine TopBorder	contains a description of the top border line of each cell.
BorderLine BottomBorder	contains a description of the bottom border line of each cell.
BorderLine LeftBorder	contains a description of the left border line of each cell.
BorderLine RightBorder	contains a description of the right border line of each cell.
long NumberFormat	contains the index of the number format that is used in the cells.
ShadowFormat ShadowFormat	contains a description of the shadow.
::com::sun::star::util::CellProtection CellProtection	contains a description of the cell protection.
::com::sun::star::container::XNameContainer UserDefinedAttributes	[ OPTIONAL ] stores additional attributes.
BorderLine DiagonalTLBR	[ OPTIONAL ] contains a description of the top left to bottom right diagonal line of each cell.
BorderLine DiagonalBLTR	[ OPTIONAL ] contains a description of the bottom left to top right diagonal line of each cell.
boolean ShrinkToFit	[ OPTIONAL ] is true, if the cell content will be shrinked to fit in the cell.

Exported Interfaces - Details

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

Description provides access to the properties.

Properties' Details

CellStyle

string CellStyle; Usage Restrictions optional Description contains the name of the style of the cell.

CellBackColor

::com::sun::star::util::Color 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

CellHoriJustify HoriJustify; Description contains the horizontal alignment of the cell contents.

VertJustify

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

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

CellVertJustify RotateReference; Description defines at which edge rotated cells are aligned.

AsianVerticalMode

boolean AsianVerticalMode; Usage Restrictions 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

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

BorderLine TopBorder; Description contains a description of the top border line of each cell.

BottomBorder

BorderLine BottomBorder; Description contains a description of the bottom border line of each cell.

LeftBorder

BorderLine LeftBorder; Description contains a description of the left border line of each cell.

RightBorder

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 ::com::sun::star::util::NumberFormatter interface of the document.

ShadowFormat

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; Usage Restrictions optional Description stores additional attributes. This property is used i.e. by the XML filters to load and restore unknown attributes.

DiagonalTLBR

BorderLine DiagonalTLBR; Usage Restrictions optional Description contains a description of the top left to bottom right diagonal line of each cell.

DiagonalBLTR

BorderLine DiagonalBLTR; Usage Restrictions optional Description contains a description of the bottom left to top right diagonal line of each cell.

ShrinkToFit

boolean ShrinkToFit; Usage Restrictions optional Description is true, if the cell content will be shrinked to fit in the cell.

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