LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
TextTable Service Referencepublished

is a table of text cells which is anchored to a surrounding text. More...

import"TextTable.idl";

Inheritance diagram for TextTable:
XCellRangeData XSortable XAutoFormattable XChartDataArray XCellRange XNamed XTextTable UserDefinedAttributesSupplier TextContent Paragraph

Included Services

service com::sun::star::text::TextContent
 
service com::sun::star::xml::UserDefinedAttributesSupplier
 

Exported Interfaces

interface com::sun::star::text::XTextTable
 
interface com::sun::star::container::XNamed
 
interface com::sun::star::table::XCellRange
 
interface com::sun::star::chart::XChartDataArray
 
interface com::sun::star::table::XAutoFormattable
 
interface com::sun::star::util::XSortable
 
interface com::sun::star::sheet::XCellRangeData
 
- Exported Interfaces inherited from TextContent
interface com::sun::star::text::XTextContent
 This interface is used for the attachment of this text content to the surrounding text. More...
 

Public Attributes

com::sun::star::style::BreakType BreakType
 determines the type of break that is applied at the beginning of the table. More...
 
long LeftMargin
 contains the left margin of the table. More...
 
long RightMargin
 contains the right margin of the table. More...
 
short HoriOrient
 contains the horizontal orientation. More...
 
boolean KeepTogether
 Setting this property to TRUE prevents page or column breaks between this table and the following paragraph or text table. More...
 
boolean Split
 Setting this property to FALSE prevents the table from getting spread on two pages. More...
 
short PageNumberOffset
 If a page break property is set at the table, this property contains the new value for the page number. More...
 
string PageDescName
 If this property is set, it creates a page break before the table and assigns the value as the name of the new page style sheet to use. More...
 
short RelativeWidth
 determines the width of the table relative to its environment. More...
 
boolean IsWidthRelative
 determines if the value of the relative width is valid. More...
 
boolean RepeatHeadline
 determines if the first row of the table is repeated on every new page. More...
 
long HeaderRowCount
 determines the number of rows of the table repeated on every new page. More...
 
com::sun::star::table::ShadowFormat ShadowFormat
 determines the type, color and size of the shadow. More...
 
long TopMargin
 determines the top margin. More...
 
long BottomMargin
 determines the bottom margin. More...
 
boolean BackTransparent
 determines if the background color is transparent. More...
 
long Width
 contains the absolute table width. More...
 
boolean ChartRowAsLabel
 determines if the first row of the table should be treated as axis labels when a chart is to be created. More...
 
boolean ChartColumnAsLabel
 determines if the first column of the table should be treated as axis labels when a chart is to be created. More...
 
com::sun::star::table::TableBorder TableBorder
 contains the description of the table borders. More...
 
sequence< com::sun::star::text::TableColumnSeparatorTableColumnSeparators
 contains the column description of the table. More...
 
short TableColumnRelativeSum
 contains the sum of the column width values used in TableColumnSeparators. More...
 
com::sun::star::util::Color BackColor
 contains the color of the background. More...
 
string BackGraphicURL
 contains the URL for the background graphic. More...
 
string BackGraphicFilter
 contains the name of the file filter for the background graphic. More...
 
com::sun::star::style::GraphicLocation BackGraphicLocation
 determines the position of the background graphic. More...
 
boolean CollapsingBorders
 determines whether borders of neighboring table cells are collapsed into one More...
 
sequence< com::sun::star::beans::PropertyValueTableInteropGrabBag
 Grab bag of table properties, used as a string-any map for interim interop purposes. More...
 
string TableTemplateName
 contains the name of table style used by the table. More...
 
com::sun::star::graphic::XGraphic BackGraphic
 contains the graphic for the background. More...
 
- Public Attributes inherited from TextContent
com::sun::star::text::TextContentAnchorType AnchorType
 specifies how the text content is attached to its surrounding Text. More...
 
sequence< com::sun::star::text::TextContentAnchorTypeAnchorTypes
 contains the anchor type of the text content. More...
 
com::sun::star::text::WrapTextMode TextWrap
 specifies if the text content is a shape and how the text is wrapped around the shape. More...
 

Additional Inherited Members

- Public Member Functions inherited from XTextContent
void attach ([in] com::sun::star::text::XTextRange xTextRange) raises ( com::sun::star::lang::IllegalArgumentException )
 is called when this object gets embedded in a text. More...
 
com::sun::star::text::XTextRange getAnchor ()
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener 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 XTextTable
void initialize ([in] long nRows, [in] long nColumns)
 determines the numbers of rows and columns of the text table. More...
 
com::sun::star::table::XTableRows getRows ()
 
com::sun::star::table::XTableColumns getColumns ()
 
com::sun::star::table::XCell getCellByName ([in] string aCellName)
 
sequence< string > getCellNames ()
 
com::sun::star::text::XTextTableCursor createCursorByCellName ([in] string aCellName)
 creates a text table cursor and returns the XTextTableCursor interface. More...
 
- Public Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 
- Public Member Functions inherited from XCellRange
com::sun::star::table::XCell getCellByPosition ([in] long nColumn, [in] long nRow) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a single cell within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByPosition ([in] long nLeft, [in] long nTop, [in] long nRight, [in] long nBottom) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a sub-range of cells within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByName ([in] string aRange)
 Returns a sub-range of cells within the range. More...
 
- Public Member Functions inherited from XChartDataArray
sequence< sequence< double > > getData ()
 retrieves the numerical data as a nested sequence of values. More...
 
void setData ([in] sequence< sequence< double > > aData)
 sets the chart data as an array of numbers. More...
 
sequence< string > getRowDescriptions ()
 retrieves the description texts for all rows. More...
 
void setRowDescriptions ([in] sequence< string > aRowDescriptions)
 sets the description texts for all rows. More...
 
sequence< string > getColumnDescriptions ()
 retrieves the description texts for all columns. More...
 
void setColumnDescriptions ([in] sequence< string > aColumnDescriptions)
 sets the description texts for all columns. More...
 
- Public Member Functions inherited from XChartData
void addChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 allows a component supporting the XChartDataChangeEventListener interface to register as listener. More...
 
void removeChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 removes a previously registered listener. More...
 
double getNotANumber ()
 
boolean isNotANumber ([in] double nNumber)
 checks whether the value given is equal to the indicator value for a missing value. More...
 
- Public Member Functions inherited from XAutoFormattable
void autoFormat ([in] string aName) raises ( com::sun::star::lang::IllegalArgumentException )
 applies an AutoFormat to the cell range of the current context. More...
 
- Public Member Functions inherited from XSortable
sequence< com::sun::star::beans::PropertyValuecreateSortDescriptor ()
 
void sort ([in] sequence< com::sun::star::beans::PropertyValue > xDescriptor)
 sorts the contents of the object according to the specified properties. More...
 
- Protected Member Functions inherited from XTextTable
void initialize ([in] long nRows, [in] long nColumns)
 determines the numbers of rows and columns of the text table. More...
 
com::sun::star::table::XTableRows getRows ()
 
com::sun::star::table::XTableColumns getColumns ()
 
com::sun::star::table::XCell getCellByName ([in] string aCellName)
 
sequence< string > getCellNames ()
 
com::sun::star::text::XTextTableCursor createCursorByCellName ([in] string aCellName)
 creates a text table cursor and returns the XTextTableCursor interface. More...
 
- Protected Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 
- Protected Member Functions inherited from XCellRange
com::sun::star::table::XCell getCellByPosition ([in] long nColumn, [in] long nRow) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a single cell within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByPosition ([in] long nLeft, [in] long nTop, [in] long nRight, [in] long nBottom) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a sub-range of cells within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByName ([in] string aRange)
 Returns a sub-range of cells within the range. More...
 
- Protected Member Functions inherited from XChartDataArray
sequence< sequence< double > > getData ()
 retrieves the numerical data as a nested sequence of values. More...
 
void setData ([in] sequence< sequence< double > > aData)
 sets the chart data as an array of numbers. More...
 
sequence< string > getRowDescriptions ()
 retrieves the description texts for all rows. More...
 
void setRowDescriptions ([in] sequence< string > aRowDescriptions)
 sets the description texts for all rows. More...
 
sequence< string > getColumnDescriptions ()
 retrieves the description texts for all columns. More...
 
void setColumnDescriptions ([in] sequence< string > aColumnDescriptions)
 sets the description texts for all columns. More...
 
- Protected Member Functions inherited from XChartData
void addChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 allows a component supporting the XChartDataChangeEventListener interface to register as listener. More...
 
void removeChartDataChangeEventListener ([in] com::sun::star::chart::XChartDataChangeEventListener aListener)
 removes a previously registered listener. More...
 
double getNotANumber ()
 
boolean isNotANumber ([in] double nNumber)
 checks whether the value given is equal to the indicator value for a missing value. More...
 
- Protected Member Functions inherited from XAutoFormattable
void autoFormat ([in] string aName) raises ( com::sun::star::lang::IllegalArgumentException )
 applies an AutoFormat to the cell range of the current context. More...
 
- Protected Member Functions inherited from XSortable
sequence< com::sun::star::beans::PropertyValuecreateSortDescriptor ()
 
void sort ([in] sequence< com::sun::star::beans::PropertyValue > xDescriptor)
 sorts the contents of the object according to the specified properties. More...
 
- Protected Member Functions inherited from XCellRangeData
sequence< sequence< any > > getDataArray ()
 gets an array from the contents of the cell range. More...
 
void setDataArray ([in] sequence< sequence< any > > aArray)
 fills the cell range with values from an array. More...
 
- Protected Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer UserDefinedAttributes
 This container holds the AttributeData elements that represent uninterpreted XML attributes. More...
 

Detailed Description

is a table of text cells which is anchored to a surrounding text.

Note: The anchor of the actual implementation for text tables does not have a position in the text. Thus that anchor can not be used for some operation like XTextContent::attach() or XText::insertTextContent() or other function that require the object to have a position in the text.

The reason why a text table still needs an anchor is that for example tables should be insertable via XText::insertTextContent() and that interface uses a parameter of that type.

Example: Create and insert a TextTable:

1 xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" )
2 xTable.initialize(5, 8)
3 xTable.HoriOrient = 0 'com::sun::star::text::HoriOrientation::NONE
4 xTable.LeftMargin = 2000
5 xTable.RightMargin = 1500
6 xTextDoc.getText.insertTextContent( xTextRange, xTable, false )
See also
com::sun::star::text::Cell
com::sun::star::text::CellRange
com::sun::star::text::TableColumns
com::sun::star::text::TableRows
com::sun::star::text::TextTableCursor
Developers Guide
Text - Tables - Table Architecture

Exported Interfaces

Exported Interfaces

Member Data Documentation

com::sun::star::util::Color BackColor
property

contains the color of the background.

com::sun::star::graphic::XGraphic BackGraphic
optionalproperty

contains the graphic for the background.

Since
LibreOffice 6.1
string BackGraphicFilter
property

contains the name of the file filter for the background graphic.

com::sun::star::style::GraphicLocation BackGraphicLocation
property

determines the position of the background graphic.

See also
GraphicLocation
string BackGraphicURL
property

contains the URL for the background graphic.

Deprecated:
as of LibreOffice 6.1 - use BackGraphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the BackGraphic property.

boolean BackTransparent
property

determines if the background color is transparent.

long BottomMargin
property

determines the bottom margin.

determines the type of break that is applied at the beginning of the table.

See also
com::sun::star::style::BreakType
boolean ChartColumnAsLabel
property

determines if the first column of the table should be treated as axis labels when a chart is to be created.

boolean ChartRowAsLabel
property

determines if the first row of the table should be treated as axis labels when a chart is to be created.

boolean CollapsingBorders
optionalproperty

determines whether borders of neighboring table cells are collapsed into one

long HeaderRowCount
optionalproperty

determines the number of rows of the table repeated on every new page.

short HoriOrient
property

contains the horizontal orientation.

See also
com::sun::star::text::HoriOrientation
boolean IsWidthRelative
property

determines if the value of the relative width is valid.

boolean KeepTogether
property

Setting this property to TRUE prevents page or column breaks between this table and the following paragraph or text table.

long LeftMargin
property

contains the left margin of the table.

string PageDescName
property

If this property is set, it creates a page break before the table and assigns the value as the name of the new page style sheet to use.

short PageNumberOffset
property

If a page break property is set at the table, this property contains the new value for the page number.

short RelativeWidth
property

determines the width of the table relative to its environment.

boolean RepeatHeadline
property

determines if the first row of the table is repeated on every new page.

long RightMargin
property

contains the right margin of the table.

com::sun::star::table::ShadowFormat ShadowFormat
property

determines the type, color and size of the shadow.

See also
com::sun::star::table::ShadowFormat
boolean Split
property

Setting this property to FALSE prevents the table from getting spread on two pages.

com::sun::star::table::TableBorder TableBorder
property

contains the description of the table borders.

See also
com::sun::star::table::TableBorder
short TableColumnRelativeSum
property

contains the sum of the column width values used in TableColumnSeparators.

sequence<com::sun::star::text::TableColumnSeparator> TableColumnSeparators
property

contains the column description of the table.

See also
com::sun::star::text::TableColumnSeparator
sequence<com::sun::star::beans::PropertyValue> TableInteropGrabBag
optionalproperty

Grab bag of table 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.

string TableTemplateName
optionalproperty

contains the name of table style used by the table.

Since
LibreOffice 5.3
long TopMargin
property

determines the top margin.

long Width
property

contains the absolute table width.

As this is only a describing property the value of the actual table may vary depending on the environment the table is located in and the settings of LeftMargin, RightMargin and HoriOrient.


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