|
LibreOffice
LibreOffice 24.8 SDK API Reference
|
represents a single cell within a text table. More...
import "Cell.idl";
Included Services | |
| service | com::sun::star::text::CellProperties |
| contains the properties of the text table cell. | |
| service | com::sun::star::table::CellProperties |
| contains properties from table cells. | |
| Included Services inherited from CellProperties | |
| service | com::sun::star::xml::UserDefinedAttributesSupplier |
| contains user defined attributes. | |
Exported Interfaces | |
| interface | com::sun::star::table::XCell |
| provides access to the cell contents. | |
| interface | com::sun::star::text::XText |
| provides access to formatted and unformatted text contents. | |
| Exported Interfaces inherited from CellProperties | |
| interface | com::sun::star::beans::XPropertySet |
| gives access to the objects properties | |
| Exported Interfaces inherited from CellProperties | |
| interface | com::sun::star::beans::XPropertySet |
| published service PropertySet | |
Additional Inherited Members | |
| Public Types inherited from CellProperties | |
| typedef sequence< com::sun::star::beans::PropertyValue > | CellInteropGrabBag |
| Grab bag of cell properties, used as a string-any map for interim interop purposes. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. | |
| void | acquire () |
| increases the reference counter by one. | |
| void | release () |
| decreases the reference counter by one. | |
| Public Member Functions inherited from XCell | |
| string | getFormula () |
| returns the formula string of a cell. | |
| void | setFormula ([in] string aFormula) |
| sets a formula into the cell. | |
| double | getValue () |
| returns the floating point value of the cell. | |
| void | setValue ([in] double nValue) |
| sets a floating point value into the cell. | |
| com::sun::star::table::CellContentType | getType () |
| returns the type of the cell. | |
| long | getError () |
| returns the error value of the cell. | |
| 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. | |
| void | removeTextContent ([in] com::sun::star::text::XTextContent xContent) raises ( com::sun::star::container::NoSuchElementException ) |
| removes the specified content from the text object. | |
| 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. | |
| 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. | |
| 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. | |
| Public Attributes inherited from CellProperties | |
| string | CellName |
| contains the cell name, see SwXTextTable::getCellByName for more information | |
| com::sun::star::util::Color | BackColor |
| contains the background color. | |
| string | BackGraphicURL |
| contains the URL to the background graphic. | |
| string | BackGraphicFilter |
| contains the name of the graphic filter of the background graphic. | |
| com::sun::star::style::GraphicLocation | BackGraphicLocation |
| determines the position of the background graphic. | |
| long | NumberFormat |
| contains the number format. | |
| boolean | BackTransparent |
| determines whether the background is transparent. | |
| com::sun::star::table::BorderLine | LeftBorder |
| contains the left border line. | |
| com::sun::star::table::BorderLine | RightBorder |
| contains the right border line. | |
| com::sun::star::table::BorderLine | TopBorder |
| contains the top border line. | |
| com::sun::star::table::BorderLine | BottomBorder |
| contains the bottom border line. | |
| long | LeftBorderDistance |
| contains the distance of the left border. | |
| long | RightBorderDistance |
| contains the distance of the right border. | |
| long | TopBorderDistance |
| contains the distance of the top border. | |
| long | BottomBorderDistance |
| contains the distance of the bottom border. | |
| com::sun::star::text::XTextSection | TextSection |
| contains the text section the text table is contained in if there is any. | |
| boolean | IsProtected |
| determines whether the cell is write protected or not. | |
| short | VertOrient |
| the vertical orientation of the text inside of the table cells in this row. | |
| com::sun::star::graphic::XGraphic | BackGraphic |
| contains the graphic object that is displayed as background graphic. | |
| com::sun::star::text::XText | ParentText |
| Parent text of this table cell. | |
| boolean | HasTextChangesOnly |
| If TRUE, the table cell wasn't deleted or inserted with its tracked cell content. | |
| Public Attributes inherited from UserDefinedAttributesSupplier | |
| ::com::sun::star::container::XNameContainer | UserDefinedAttributes |
| This container holds the AttributeData elements that represent uninterpreted XML attributes. | |
| Public Attributes inherited from CellProperties | |
| string | CellStyle |
| 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. | |
| com::sun::star::table::CellHoriJustify | HoriJustify |
| contains the horizontal alignment of the cell contents. | |
| long | 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). | |
| com::sun::star::table::CellOrientation | Orientation |
| contains the orientation of the cell contents. | |
| long | RotateAngle |
| defines how much the content of cells is rotated (in 1/100 degrees). | |
| long | RotateReference |
| defines at which edge rotated cells are aligned. | |
| boolean | AsianVerticalMode |
| selects Asian character orientation in vertical orientation. | |
| com::sun::star::table::TableBorder | TableBorder |
| contains a description of the cell or cell range border. | |
| com::sun::star::table::BorderLine | TopBorder |
| contains a description of the top border line of each cell. | |
| com::sun::star::table::BorderLine | BottomBorder |
| contains a description of the bottom border line of each cell. | |
| com::sun::star::table::BorderLine | LeftBorder |
| contains a description of the left border line of each cell. | |
| com::sun::star::table::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. | |
| com::sun::star::table::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 |
| stores additional attributes. | |
| com::sun::star::table::BorderLine | DiagonalTLBR |
| contains a description of the top left to bottom right diagonal line of each cell. | |
| com::sun::star::table::BorderLine | DiagonalBLTR |
| contains a description of the bottom left to top right diagonal line of each cell. | |
| boolean | ShrinkToFit |
| is TRUE, if the cell content will be shrunk to fit in the cell. | |
| com::sun::star::table::TableBorder2 | TableBorder2 |
| contains a description of the cell or cell range border. | |
| com::sun::star::table::BorderLine2 | TopBorder2 |
| contains a description of the top border line of each cell. | |
| com::sun::star::table::BorderLine2 | BottomBorder2 |
| contains a description of the bottom border line of each cell. | |
| com::sun::star::table::BorderLine2 | LeftBorder2 |
| contains a description of the left border line of each cell. | |
| com::sun::star::table::BorderLine2 | RightBorder2 |
| contains a description of the right border line of each cell. | |
| com::sun::star::table::BorderLine2 | DiagonalTLBR2 |
| contains a description of the top left to bottom right diagonal line of each cell. | |
| com::sun::star::table::BorderLine2 | DiagonalBLTR2 |
| contains a description of the bottom left to top right diagonal line of each cell. | |
represents a single cell within a text table.
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:
contains the properties of the text table cell.
| interface com::sun::star::table::XCell |
provides access to the cell contents.
| interface com::sun::star::text::XText |
provides access to formatted and unformatted text contents.