Properties' Summary |
::com::sun::star::style::BreakType
BreakType |
determines 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 |
determines the width of the table relative to its environment.
|
boolean
IsWidthRelative |
determines if the value of the relative width is valid.
|
boolean
RepeatHeadline |
determines if the first row of the table is repeated on every new page.
|
long
HeaderRowCount |
[ OPTIONAL ]
determines the number of rows of the table repeated on every new page.
|
::com::sun::star::table::ShadowFormat
ShadowFormat |
determines the type, color and size of the shadow. |
long
TopMargin |
determines the top margin.
|
long
BottomMargin |
determines the bottom margin.
|
boolean
BackTransparent |
determines if the background color is transparent.
|
long
Width |
contains the absolute table width.
|
boolean
ChartRowAsLabel |
determines if the first row of the table should be treated as
axis labels when a chart is to be created.
|
boolean
ChartColumnAsLabel |
determines 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 |
[ DEPRECATED ]
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 neighboring table cells are
* collapsed into one
|
sequence< ::com::sun::star::beans::PropertyValue >
TableInteropGrabBag |
[ OPTIONAL ]
Grab bag of table properties, used as a string-any map for interim interop purposes.
Since LibreOffice 4.3
|
string
TableTemplateName |
[ OPTIONAL ]
contains the name of table style used by the table.
Since LibreOffice 5.3
|
::com::sun::star::graphic::XGraphic
BackGraphic |
[ OPTIONAL ]
contains the graphic for the background.
Since LibreOffice 6.1
|
Properties' Details |
BreakType
::com::sun::star::style::BreakType BreakType;
- Description
- determines 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
- 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
- determines the width of the table relative to its environment.
|
|
IsWidthRelative
boolean IsWidthRelative;
- Description
- determines if the value of the relative width is valid.
|
|
RepeatHeadline
boolean RepeatHeadline;
- Description
- determines if the first row of the table is repeated on every new page.
|
|
HeaderRowCount
long HeaderRowCount;
- Usage Restrictions
- optional
- Description
- determines the number of rows of the table repeated on every new page.
|
|
ShadowFormat
|
TopMargin
long TopMargin;
- Description
- determines the top margin.
|
|
BottomMargin
long BottomMargin;
- Description
- determines the bottom margin.
|
|
BackTransparent
boolean BackTransparent;
- Description
- determines 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
- determines if the first row of the table should be treated as
axis labels when a chart is to be created.
|
|
ChartColumnAsLabel
boolean ChartColumnAsLabel;
- Description
- determines if the first column of the table should be treated as
axis labels when a chart is to be created.
|
|
TableBorder
|
TableColumnSeparators
|
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;
- Usage Restrictions
- deprecated
- Deprecation Info
- 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.
- Description
- contains the URL for the background graphic.
|
|
BackGraphicFilter
string BackGraphicFilter;
- Description
- contains the name of the file filter for the background graphic.
|
|
BackGraphicLocation
|
CollapsingBorders
boolean CollapsingBorders;
- Usage Restrictions
- optional
- Description
- determines whether borders of neighboring table cells are
* collapsed into one
|
|
TableInteropGrabBag
sequence< ::com::sun::star::beans::PropertyValue > TableInteropGrabBag;
- Usage Restrictions
- optional
- Description
- 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.
|
|
TableTemplateName
string TableTemplateName;
- Usage Restrictions
- optional
- Description
- contains the name of table style used by the table.
Since LibreOffice 5.3
|
|
BackGraphic
::com::sun::star::graphic::XGraphic BackGraphic;
- Usage Restrictions
- optional
- Description
- contains the graphic for the background.
Since LibreOffice 6.1
|
|
Copyright © 2020, 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.