service TextTable in module com::sun::star::text::

(Global Index)

Syntax

service TextTable;

Description

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

If the document in which a table is to be inserted has its own XMultiServiceFactory , this must be used to create the instance.

If a descriptor is used, a descriptor created by the same XMultiServiceFactory must be used.

Example

Create and insert a TextTable via a TextTableDescriptor:
 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 )
Create and insert a TextTable directly (may flicker):
 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 )

Included Services

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

Description

is an object which can be anchored in a text, like instances of TextFrame or TextFields .


Exported Interfaces

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

Description

manages a text table.


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

Description

specifies the name of the object.


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

Description

represents a range of cells in a table.


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

Description

gives access to data represented as an array of rows.


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

Description

represents a table (or part of a table) to which AutoFormats can be applied.


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

Description

makes it possible to sort the contents of this object.


Property Summary

BreakType determins the type of break that is applied at the beginning of the table.

LeftMargin contains the left margin of the table.

RightMargin contains the right margin of the table.

HoriOrient contains the horizontal orientation.

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

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

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

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.

RelativeWidth determins the width of the table relative to its environment.

IsWidthRelative determins if the value of the relative width is valid.

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

ShadowFormat determins the type, color and size of the shadow.

TopMargin determins the top margin.

BottomMargin determins the bottom margin.

BackTransparent determins if the background color is transparent.

Width contains the absolute table width.

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

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

TableBorder contains the description of the table borders.

TableColumnSeparators contains the column description of the table.

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

BackColor contains the color of the background.

BackGraphicURL contains the URL for the background graphic.

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

BackGraphicLocation determines the position of the background graphic.

Property Details



BreakType

Syntax

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

Syntax

long LeftMargin;

Description

contains the left margin of the table.


RightMargin

Syntax

long RightMargin;

Description

contains the right margin of the table.


HoriOrient

Syntax

short HoriOrient;

Description

contains the horizontal orientation.

See also

com.sun.star.text.HoriOrientation

KeepTogether

Syntax

boolean KeepTogether;

Description

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


Split

Syntax

boolean Split;

Description

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


PageNumberOffset

Syntax

short PageNumberOffset;

Description

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


PageDescName

Syntax

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

Syntax

short RelativeWidth;

Description

determins the width of the table relative to its environment.


IsWidthRelative

Syntax

boolean IsWidthRelative;

Description

determins if the value of the relative width is valid.


RepeatHeadline

Syntax

boolean RepeatHeadline;

Description

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


ShadowFormat

Syntax

com::sun::star::table::ShadowFormat ShadowFormat;

Description

determins the type, color and size of the shadow.

See also

com.sun.star.table.ShadowFormat

TopMargin

Syntax

long TopMargin;

Description

determins the top margin.


BottomMargin

Syntax

long BottomMargin;

Description

determins the bottom margin.


BackTransparent

Syntax

boolean BackTransparent;

Description

determins if the background color is transparent.


Width

Syntax

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

Syntax

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

Syntax

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

Syntax

com::sun::star::table::TableBorder TableBorder;

Description

contains the description of the table borders.

See also

com.sun.star.table.TableBorder

TableColumnSeparators

Syntax

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

Description

contains the column description of the table.

See also

com.sun.star.text.TableColumnSeparator

TableColumnRelativeSum

Syntax

short TableColumnRelativeSum;

Description

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


BackColor

Syntax

long BackColor;

Description

contains the color of the background.


BackGraphicURL

Syntax

string BackGraphicURL;

Description

contains the URL for the background graphic.


BackGraphicFilter

Syntax

string BackGraphicFilter;

Description

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


BackGraphicLocation

Syntax

com::sun::star::style::GraphicLocation BackGraphicLocation;

Description

determines the position of the background graphic.

See also

GraphicLocation
Top of Page