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

represents a page style for a spreadsheet. More...

import"TablePageStyle.idl";

Inheritance diagram for TablePageStyle:
PageStyle Style PageProperties UserDefinedAttributesSupplier XStyle XPropertySet XMultiPropertySet XMultiPropertyStates XNamed XInterface XInterface XInterface XInterface

Included Services

service com::sun::star::style::PageStyle
 contains all common page style properties. More...
 
- Included Services inherited from PageStyle
service com::sun::star::style::Style
 provides common functionality for styles. More...
 
service com::sun::star::style::PageProperties
 gives access to the pages properties. More...
 
- Included Services inherited from Style
service com::sun::star::xml::UserDefinedAttributesSupplier
 contains user defined attributes. More...
 

Public Attributes

boolean CenterHorizontally
 determines whether the table is centered horizontally on the page. More...
 
boolean CenterVertically
 determines whether the table is centered vertically on the page. More...
 
boolean PrintAnnotations
 enables printing of cell annotations. More...
 
boolean PrintGrid
 enables printing of the cell grid. More...
 
boolean PrintHeaders
 enables printing of column and row headers. More...
 
boolean PrintCharts
 enables printing of charts. More...
 
boolean PrintObjects
 enables printing of embedded objects. More...
 
boolean PrintDrawing
 enables printing of drawing objects. More...
 
boolean PrintFormulas
 enables printing of formulas instead of their results. More...
 
boolean PrintZeroValues
 enables printing of zero-values. More...
 
boolean PrintDownFirst
 specifies the print order for the pages within each sheet. More...
 
com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent
 contains the content of the header for left pages. More...
 
com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent
 contains the content of the footer for left pages. More...
 
com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent
 contains the content of the header for right pages. More...
 
com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent
 contains the content of the footer for right pages. More...
 
short FirstPageNumber
 contains the page number applied to the first page for this sheet. More...
 
short PageScale
 contains the scaling factor (in percent) for printing the sheet. More...
 
short ScaleToPages
 contains the number of pages the sheet will printed. More...
 
short ScaleToPagesX
 contains the number of horizontal pages the sheet will printed on. More...
 
short ScaleToPagesY
 contains the number of vertical pages the sheet will printed on. More...
 
- Public Attributes inherited from Style
boolean IsPhysical
 determines if a style is physically created. More...
 
string FollowStyle
 contains the name of the style that is applied to the next paragraph. More...
 
string DisplayName
 contains the name of the style as it is displayed in the user interface. More...
 
string IsAutoUpdate
 determines if a style is automatically updated, if the properties of an object that the style is applied to are changed. More...
 
sequence< com::sun::star::beans::NamedValueParaStyleConditions
 defines the context and styles for conditional paragraphs. More...
 
boolean Hidden
 Flag indicating whether to hide the style in the UI. More...
 
sequence< com::sun::star::beans::PropertyValueStyleInteropGrabBag
 Grab bag of style properties, used as a string-any map for interim interop purposes. More...
 
- Public Attributes inherited from PageProperties
com::sun::star::util::Color BackColor
 contains the background color of the page. More...
 
string BackGraphicURL
 contains the URL of the background graphic. More...
 
string BackGraphicFilter
 contains the filter name of the background graphic. More...
 
com::sun::star::style::GraphicLocation BackGraphicLocation
 determines the location of the background graphic. More...
 
boolean BackTransparent
 determines if the background color is transparent. More...
 
long LeftMargin
 determines the left margin of the page. More...
 
long RightMargin
 determines the right margin of the page. More...
 
long TopMargin
 determines the top margin of the page. More...
 
long BottomMargin
 determines the bottom margin of the page. More...
 
com::sun::star::table::BorderLine LeftBorder
 determines the style of the left border line of the page. More...
 
com::sun::star::table::BorderLine RightBorder
 determines the style of the right border line of the page. More...
 
com::sun::star::table::BorderLine TopBorder
 determines the style of the top border line of the page. More...
 
com::sun::star::table::BorderLine BottomBorder
 determines the style of the bottom border line of the page. More...
 
long LeftBorderDistance
 determines the left border distance of the page. More...
 
long RightBorderDistance
 determines the right border distance of the page. More...
 
long TopBorderDistance
 determines the top border distance of the page. More...
 
long BottomBorderDistance
 determines the bottom border distance of the page. More...
 
com::sun::star::table::ShadowFormat ShadowFormat
 determines the shadow of the page. More...
 
boolean IsLandscape
 determines if the page format is landscape. More...
 
short NumberingType
 determines the default numbering type for this page. More...
 
com::sun::star::style::PageStyleLayout PageStyleLayout
 determines the layout of the page. More...
 
string PrinterPaperTray
 contains the name of a paper tray of the selected printer. More...
 
boolean RegisterModeActive
 determines if the register mode is active on that page. More...
 
string RegisterParagraphStyle
 contains the name of the paragraph style that is used as reference of the register mode. More...
 
com::sun::star::awt::Size Size
 contains the paper size of the page. More...
 
long Width
 contains the width of the page. More...
 
long Height
 contains the height of the page. More...
 
com::sun::star::text::XTextColumns TextColumns
 contains the column settings of the page. More...
 
com::sun::star::container::XNameContainer UserDefinedAttributes
 contains user defined attributes. More...
 
com::sun::star::util::Color HeaderBackColor
 contains the color of the background of the header. More...
 
string HeaderBackGraphicURL
 contains the URL of the background graphic of the header. More...
 
string HeaderBackGraphicFilter
 contains the filter name of the background graphic of the header. More...
 
com::sun::star::style::GraphicLocation HeaderBackGraphicLocation
 determines the location of the background graphic of the header. More...
 
long HeaderLeftMargin
 contains the left margin of the header. More...
 
long HeaderRightMargin
 contains the right margin of the header. More...
 
boolean HeaderBackTransparent
 determines if the background color of the header is transparent. More...
 
com::sun::star::table::BorderLine HeaderLeftBorder
 determines the style of the left border line of the header. More...
 
com::sun::star::table::BorderLine HeaderRightBorder
 determines the style of the right border line of the header. More...
 
com::sun::star::table::BorderLine HeaderTopBorder
 determines the style of the top border line of the header. More...
 
com::sun::star::table::BorderLine HeaderBottomBorder
 determines the style of the bottom border line of the header. More...
 
long HeaderLeftBorderDistance
 determines the left border distance of the header. More...
 
long HeaderRightBorderDistance
 determines the right border distance of the header. More...
 
long HeaderTopBorderDistance
 determines the top border distance of the header. More...
 
long HeaderBottomBorderDistance
 determines the bottom border distance of the header. More...
 
com::sun::star::table::ShadowFormat HeaderShadowFormat
 determines the shadow of the header. More...
 
long HeaderBodyDistance
 determines the distance between the header and the body text area. More...
 
boolean HeaderIsShared
 determines if the header content on left and right pages is the same. More...
 
boolean FirstIsShared
 determines if the header/footer content on the first page and remaining pages is the same. More...
 
long HeaderHeight
 contains the height of the header. More...
 
boolean HeaderIsDynamicHeight
 determines if the height of the header depends on the content. More...
 
boolean HeaderIsOn
 determines if a header is used on the page. More...
 
com::sun::star::text::XText HeaderText
 contains the interface to the text of the header. More...
 
com::sun::star::text::XText HeaderTextLeft
 contains the interface to the text of the header of left pages. More...
 
com::sun::star::text::XText HeaderTextRight
 contains the interface to the text of the header of right pages. More...
 
com::sun::star::util::Color FooterBackColor
 contains the color of the background of the footer. More...
 
string FooterBackGraphicURL
 contains the URL of the background graphic in the footer. More...
 
string FooterBackGraphicFilter
 contains the filter name of the background graphic in the footer. More...
 
com::sun::star::style::GraphicLocation FooterBackGraphicLocation
 determines the location of the background graphic in the footer. More...
 
long FooterLeftMargin
 determines the left margin of the footer. More...
 
long FooterRightMargin
 determines the right margin of the footer. More...
 
boolean FooterBackTransparent
 determines if the background of the footer is transparent. More...
 
com::sun::star::table::BorderLine FooterLeftBorder
 contains the style of the left border line of the footer. More...
 
com::sun::star::table::BorderLine FooterRightBorder
 contains the style of the right border line of the footer. More...
 
com::sun::star::table::BorderLine FooterTopBorder
 contains the style of the top border line of the footer. More...
 
com::sun::star::table::BorderLine FooterBottomBorder
 contains the style of the bottom border line of the footer. More...
 
long FooterLeftBorderDistance
 contains the left border distance of the footer. More...
 
long FooterRightBorderDistance
 contains the right border distance of the footer. More...
 
long FooterTopBorderDistance
 contains the top border distance of the footer. More...
 
long FooterBottomBorderDistance
 contains the bottom border distance of the footer. More...
 
com::sun::star::table::ShadowFormat FooterShadowFormat
 determines the shadow of the footer. More...
 
long FooterBodyDistance
 determines the distance between the footer and the body text area. More...
 
boolean FooterIsDynamicHeight
 determines if the height of the footer depends on the content. More...
 
boolean FooterIsShared
 determines if the footer content on left and right pages is the same. More...
 
long FooterHeight
 determines the height of the footer. More...
 
boolean FooterIsOn
 determines if a footer is used on the page. More...
 
com::sun::star::text::XText FooterText
 contains the interface to the text of the footer. More...
 
com::sun::star::text::XText FooterTextLeft
 contains the interface to the text of the footer of a left page. More...
 
com::sun::star::text::XText FooterTextRight
 contains the interface to the text of the footer of a right page. More...
 
long FootnoteHeight
 contains the maximum height of the footnote area. More...
 
short FootnoteLineWeight
 contains the weight of the separator line between the text and the footnote area. More...
 
short FootnoteLineStyle
 contains the style of the separator line between the text and the footnote area. More...
 
com::sun::star::util::Color FootnoteLineColor
 contains the color of the separator line between the text and the footnote area. More...
 
byte FootnoteLineRelativeWidth
 contains the relative width of the separator line between the text and the footnote area. More...
 
short FootnoteLineAdjust
 contains the adjustment of the separator line between the text and the footnote area. More...
 
long FootnoteLineTextDistance
 contains the distance between the text and the separator line between the text and the footnote area. More...
 
long FootnoteLineDistance
 contains the distance between the footnote area and the separator line between the text and the footnote area. More...
 
short WritingMode
 contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants More...
 
short GridMode
 contains the mode of the text grid (none, lines, ...), as represented by com::sun::star::text::TextGridMode constants More...
 
com::sun::star::util::Color GridColor
 contains the display color of the text grid More...
 
short GridLines
 contains the number of lines in the text grid More...
 
long GridBaseHeight
 contains the height of the base text line inside the text grid More...
 
long GridRubyHeight
 contains the height of the ruby text line inside the text grid More...
 
boolean GridRubyBelow
 determines whether the text grid's ruby line is located below or above the base line More...
 
boolean GridPrint
 determines whether the text grid lines are printed More...
 
boolean GridDisplay
 determines whether the text grid lines are visible or not More...
 
boolean HeaderDynamicSpacing
 determines whether to use dynamic spacing in header or not. More...
 
boolean FooterDynamicSpacing
 determines whether to use dynamic spacing in footer or not. More...
 
long BorderDistance
 determines the distance of all borders of the page. More...
 
long FooterBorderDistance
 contains the distance of all borders of the footer. More...
 
long HeaderBorderDistance
 determines the distance of all borders of the header. More...
 
com::sun::star::graphic::XGraphic BackGraphic
 contains the graphic of the background. More...
 
com::sun::star::graphic::XGraphic HeaderBackGraphic
 contains the graphic of the background of the header. More...
 
com::sun::star::graphic::XGraphic FooterBackGraphic
 contains the graphic of the background of the footer. More...
 

Additional Inherited Members

- Exported Interfaces inherited from Style
interface com::sun::star::style::XStyle
 
interface com::sun::star::beans::XPropertySet
 
interface com::sun::star::beans::XMultiPropertySet
 
interface com::sun::star::beans::XMultiPropertyStates
 
- Public Member Functions inherited from XStyle
boolean isUserDefined ()
 identifies a style as defined by the user. More...
 
boolean isInUse ()
 
string getParentStyle ()
 
void setParentStyle ([in] string aParentStyle) raises ( com::sun::star::container::NoSuchElementException )
 sets the name of the parent style. 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 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 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
- Protected Member Functions inherited from XStyle
boolean isUserDefined ()
 identifies a style as defined by the user. More...
 
boolean isInUse ()
 
string getParentStyle ()
 
void setParentStyle ([in] string aParentStyle) raises ( com::sun::star::container::NoSuchElementException )
 sets the name of the parent style. 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 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...
 
- Protected 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
- Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values to the properties with the specified names. More...
 
sequence< any > getPropertyValues ([in] sequence< string > aPropertyNames)
 
void addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 adds an XPropertiesChangeListener to the specified property with the specified names. More...
 
void removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
 removes an XPropertiesChangeListener from the listener list. More...
 
void firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 fires a sequence of PropertyChangeEvents to the specified listener. More...
 
- Protected Member Functions inherited from XMultiPropertyStates
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 
void setAllPropertiesToDefault ()
 sets all properties to their default values. More...
 
void setPropertiesToDefault ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException )
 sets the specified properties to their default values. More...
 
sequence< any > getPropertyDefaults ([in] sequence< string > aPropertyNames) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
- 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

represents a page style for a spreadsheet.

This service extends the service com::sun::star::style::PageStyle with spreadsheet specific properties.

Developers Guide
Spreadsheets - Overall Document Features - Styles - Page Styles

Exported Interfaces

contains all common page style properties.

Member Data Documentation

boolean CenterHorizontally
property

determines whether the table is centered horizontally on the page.

boolean CenterVertically
property

determines whether the table is centered vertically on the page.

short FirstPageNumber
property

contains the page number applied to the first page for this sheet.

The value 0 indicates that the page numbers are continued from the previous sheet.

com::sun::star::sheet::XHeaderFooterContent LeftPageFooterContent
property

contains the content of the footer for left pages.

After changing the footer text contents, this property has to be reinserted into the property set.

See also
com::sun::star::sheet::HeaderFooterContent
com::sun::star::sheet::XHeaderFooterContent LeftPageHeaderContent
property

contains the content of the header for left pages.

After changing the header text contents, this property has to be reinserted into the property set.

See also
com::sun::star::sheet::HeaderFooterContent
short PageScale
property

contains the scaling factor (in percent) for printing the sheet.

boolean PrintAnnotations
property

enables printing of cell annotations.

boolean PrintCharts
property

enables printing of charts.

boolean PrintDownFirst
property

specifies the print order for the pages within each sheet.

If TRUE, the order for printing pages begins with top-to-bottom, then continues with the next set of cell columns to the right. If FALSE, the order for printing pages begins with left-to-right, then continues with the next set of cell rows to the bottom.

boolean PrintDrawing
property

enables printing of drawing objects.

boolean PrintFormulas
property

enables printing of formulas instead of their results.

boolean PrintGrid
property

enables printing of the cell grid.

boolean PrintHeaders
property

enables printing of column and row headers.

boolean PrintObjects
property

enables printing of embedded objects.

boolean PrintZeroValues
property

enables printing of zero-values.

com::sun::star::sheet::XHeaderFooterContent RightPageFooterContent
property

contains the content of the footer for right pages.

After changing the footer text contents, this property has to be reinserted into the property set.

See also
com::sun::star::sheet::HeaderFooterContent
com::sun::star::sheet::XHeaderFooterContent RightPageHeaderContent
property

contains the content of the header for right pages.

After changing the header text contents, this property has to be reinserted into the property set.

See also
com::sun::star::sheet::HeaderFooterContent
short ScaleToPages
property

contains the number of pages the sheet will printed.

short ScaleToPagesX
optionalproperty

contains the number of horizontal pages the sheet will printed on.

Since
OOo 2.0
short ScaleToPagesY
optionalproperty

contains the number of vertical pages the sheet will printed on.

Since
OOo 2.0

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