LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | List of all members
Cell Service Reference

represents a single cell within a text table. More...

import"Cell.idl";

Inheritance diagram for Cell:
CellProperties CellProperties XCell XText UserDefinedAttributesSupplier XPropertySet XPropertySet XInterface XSimpleText XInterface XInterface XTextRange XInterface

Included Services

service com::sun::star::text::CellProperties
 contains the properties of the text table cell. More...
 
service com::sun::star::table::CellProperties
 contains properties from table cells. More...
 
- Included Services inherited from CellProperties
service com::sun::star::xml::UserDefinedAttributesSupplier
 contains user defined attributes. More...
 

Exported Interfaces

interface com::sun::star::table::XCell
 provides access to the cell contents. More...
 
interface com::sun::star::text::XText
 provides access to formatted and unformatted text contents. More...
 
- Exported Interfaces inherited from CellProperties
interface com::sun::star::beans::XPropertySet
 gives access to the objects properties More...
 
- Exported Interfaces inherited from CellProperties
interface com::sun::star::beans::XPropertySet
 published service PropertySet 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...
 
- Public Member Functions inherited from XCell
string getFormula ()
 returns the formula string of a cell. More...
 
void setFormula ([in] string aFormula)
 sets a formula into the cell. More...
 
double getValue ()
 returns the floating point value of the cell. More...
 
void setValue ([in] double nValue)
 sets a floating point value into the cell. More...
 
com::sun::star::table::CellContentType getType ()
 returns the type of the cell. More...
 
long getError ()
 returns the error value of the cell. More...
 
- Public Member Functions inherited from XText
void insertTextContent ([in] com::sun::star::text::XTextRange xRange, [in] com::sun::star::text::XTextContent xContent, [in] boolean bAbsorb) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts a content, such as a text table, text frame or text field. More...
 
void removeTextContent ([in] com::sun::star::text::XTextContent xContent) raises ( com::sun::star::container::NoSuchElementException )
 removes the specified content from the text object. More...
 
- Public Member Functions inherited from XSimpleText
com::sun::star::text::XTextCursor createTextCursor ()
 
com::sun::star::text::XTextCursor createTextCursorByRange ([in] com::sun::star::text::XTextRange aTextPosition)
 
void insertString ([in] com::sun::star::text::XTextRange xRange, [in] string aString, [in] boolean bAbsorb)
 inserts a string of characters into the text. More...
 
void insertControlCharacter ([in] com::sun::star::text::XTextRange xRange, [in] short nControlCharacter, [in] boolean bAbsorb) raises ( com::sun::star::lang::IllegalArgumentException )
 inserts a control character (like a paragraph break or a hard space) into the text. More...
 
- Public Member Functions inherited from XTextRange
XText getText ()
 
XTextRange getStart ()
 
XTextRange getEnd ()
 
string getString ()
 
void setString ([in] string aString)
 the whole string of characters of this piece of text is replaced. More...
 
- Public Attributes inherited from CellProperties
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...
 
- Public Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer UserDefinedAttributes
 This container holds the AttributeData elements that represent uninterpreted XML attributes. More...
 
- Public Attributes inherited from CellProperties
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...
 
sequence< com::sun::star::beans::PropertyValueCellInteropGrabBag
 Grab bag of cell properties, used as a string-any map for interim interop purposes. More...
 

Detailed Description

represents a single cell within a text table.

See also
com::sun::star::text::TextTable

Exported Interfaces

contains properties from table cells.

All of these properties are either already available in the service com::sun::star::text::CellProperties, or get matched against one of those or are implemented non-functional since they serve no purpose for text tables.

The complete list is as follows:

  • CellStyle: optional property, not implemented.
  • CellBackColor: matched to "BackColor".
  • IsCellBackgroundTransparent: matched to "BackTransparent".
  • HoriJustify: non-functional implementation.
  • VertJustify: non-functional implementation.
  • IsTextWrapped: non-functional implementation.
  • ParaIndent: non-functional implementation.
  • Orientation: non-functional implementation.
  • RotateAngle: non-functional implementation.
  • RotateReference: non-functional implementation.
  • AsianVerticalMode: optional property, not implemented.
  • TableBorder: non-functional implementation.
  • TopBorder: already available.
  • BottomBorder: already available.
  • LeftBorder: already available.
  • RightBorder: already available.
  • NumberFormat: already available.
  • ShadowFormat: non-functional implementation.
  • CellProtection: non-functional implementation.
Since
OOo 2.0

contains the properties of the text table cell.

Exported Interfaces

provides access to the cell contents.

provides access to formatted and unformatted text contents.


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