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