Service TextTable

Overview

Module

Use

Devguide

:: com :: sun :: star :: text ::

service TextTable

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:

 xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" )
 xTable.initialize(5, 8)
 xTable.HoriOrient = 0 'com::sun::star::text::HoriOrientation::NONE
 xTable.LeftMargin = 2000
 xTable.RightMargin = 1500
 xTextDoc.getText.insertTextContent( xTextRange, xTable, false )

Developers Guide: Text - Tables - Table Architecture

Included Services - Summary
TextContent	(referenced entity's summary:) is an object which can be anchored in a text, like instances of TextFrame or TextField.
::com::sun::star::xml::UserDefinedAttributesSupplier

Exported Interfaces - Summary
XTextTable	(referenced entity's summary:) manages a text table.
::com::sun::star::container::XNamed	(referenced entity's summary:) specifies the name of the object.
::com::sun::star::table::XCellRange	(referenced entity's summary:) provides access to the cells or to sub-ranges of a cell range.
::com::sun::star::chart::XChartDataArray	(referenced entity's summary:) gives access to data represented as an array of rows.
::com::sun::star::table::XAutoFormattable	(referenced entity's summary:) provides a method to apply TableAutoFormats to a cell range.
::com::sun::star::util::XSortable	(referenced entity's summary:) makes it possible to sort the contents of this object.
::com::sun::star::sheet::XCellRangeData

Properties' Summary
::com::sun::star::style::BreakType BreakType	determins the type of break that is applied at the beginning of the table.
long LeftMargin	contains the left margin of the table.
long RightMargin	contains the right margin of the table.
short HoriOrient	contains the horizontal orientation.
boolean KeepTogether	Setting this property to TRUE prevents page or column breaks between this table and the following paragraph or text table.
boolean Split	Setting this property to FALSE prevents the table from getting spread on two pages.
short PageNumberOffset	If a page break property is set at the table, this property contains the new value for the page number.
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.
short RelativeWidth	determins the width of the table relative to its environment.
boolean IsWidthRelative	determins if the value of the relative width is valid.
boolean RepeatHeadline	determins if the first row of the table is repeated on every new page.
long HeaderRowCount	[ OPTIONAL ] determins the number of rows of the table repeated on every new page.
::com::sun::star::table::ShadowFormat ShadowFormat	determins the type, color and size of the shadow.
long TopMargin	determins the top margin.
long BottomMargin	determins the bottom margin.
boolean BackTransparent	determins if the background color is transparent.
long Width	contains the absolute table width.
boolean ChartRowAsLabel	determins if the first row of the table should be treated as axis labels when a chart is to be created.
boolean ChartColumnAsLabel	determins if the first column of the table should be treated as axis labels when a chart is to be created.
::com::sun::star::table::TableBorder TableBorder	contains the description of the table borders.
sequence< TableColumnSeparator > TableColumnSeparators	contains the column description of the table.
short TableColumnRelativeSum	contains the sum of the column width values used in TableColumnSeparators.
::com::sun::star::util::Color BackColor	contains the color of the background.
string BackGraphicURL	contains the URL for the background graphic.
string BackGraphicFilter	contains the name of the file filter for the background graphic.
::com::sun::star::style::GraphicLocation BackGraphicLocation	determines the position of the background graphic.
boolean CollapsingBorders	[ OPTIONAL ] determines whether borders of neighbouring table cells are * collapsed into one

Included Services - Details

TextContent

(referenced entity's summary:) is an object which can be anchored in a text, like instances of TextFrame or TextField.

::com::sun::star::xml::UserDefinedAttributesSupplier

Usage Restrictions optional

Exported Interfaces - Details

XTextTable

(referenced entity's summary:) manages a text table.

::com::sun::star::container::XNamed

(referenced entity's summary:) specifies the name of the object.

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

(referenced entity's summary:) provides access to the cells or to sub-ranges of a cell range.

::com::sun::star::chart::XChartDataArray

(referenced entity's summary:) gives access to data represented as an array of rows.

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

(referenced entity's summary:) provides a method to apply TableAutoFormats to a cell range.

::com::sun::star::util::XSortable

(referenced entity's summary:) makes it possible to sort the contents of this object.

::com::sun::star::sheet::XCellRangeData

Usage Restrictions optional

Properties' Details

BreakType

::com::sun::star::style::BreakType BreakType; Description determins the type of break that is applied at the beginning of the table. See also com.sun.star.style.BreakType

LeftMargin

long LeftMargin; Description contains the left margin of the table.

RightMargin

long RightMargin; Description contains the right margin of the table.

HoriOrient

short HoriOrient; Description contains the horizontal orientation. See also com.sun.star.text.HoriOrientation

KeepTogether

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

Split

boolean Split; Description Setting this property to FALSE prevents the table from getting spread on two pages.

PageNumberOffset

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

PageDescName

string PageDescName; Description 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.

RelativeWidth

short RelativeWidth; Description determins the width of the table relative to its environment.

IsWidthRelative

boolean IsWidthRelative; Description determins if the value of the relative width is valid.

RepeatHeadline

boolean RepeatHeadline; Description determins if the first row of the table is repeated on every new page.

HeaderRowCount

long HeaderRowCount; Usage Restrictions optional Description determins the number of rows of the table repeated on every new page.

ShadowFormat

::com::sun::star::table::ShadowFormat ShadowFormat; Description determins the type, color and size of the shadow. See also com.sun.star.table.ShadowFormat

TopMargin

long TopMargin; Description determins the top margin.

BottomMargin

long BottomMargin; Description determins the bottom margin.

BackTransparent

boolean BackTransparent; Description determins if the background color is transparent.

Width

long Width; Description 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.

ChartRowAsLabel

boolean ChartRowAsLabel; Description determins if the first row of the table should be treated as axis labels when a chart is to be created.

ChartColumnAsLabel

boolean ChartColumnAsLabel; Description determins if the first column of the table should be treated as axis labels when a chart is to be created.

TableBorder

::com::sun::star::table::TableBorder TableBorder; Description contains the description of the table borders. See also com.sun.star.table.TableBorder

TableColumnSeparators

sequence< TableColumnSeparator > TableColumnSeparators; Description contains the column description of the table. See also com.sun.star.text.TableColumnSeparator

TableColumnRelativeSum

short TableColumnRelativeSum; Description contains the sum of the column width values used in TableColumnSeparators.

BackColor

::com::sun::star::util::Color BackColor; Description contains the color of the background.

BackGraphicURL

string BackGraphicURL; Description contains the URL for the background graphic.

BackGraphicFilter

string BackGraphicFilter; Description contains the name of the file filter for the background graphic.

BackGraphicLocation

::com::sun::star::style::GraphicLocation BackGraphicLocation; Description determines the position of the background graphic. See also GraphicLocation

CollapsingBorders

boolean CollapsingBorders; Usage Restrictions optional Description determines whether borders of neighbouring table cells are * collapsed into one

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