Summary
The name, the datum type, and the value of each property of spread sheet page style are described.
Topics
About: UNO (Universal Network Objects)
About: LibreOffice
About: Apache OpenOffice
The table of contents of this article
Starting Context
- The reader has knowledge of what the concept of 'property of UNO object' is and how to access one (if the name and the datum type are clear).
Target Context
- The reader will know the specifications of the properties of the UNO component.
Introduction
'Orientation' is meant for the passersby who don't stand in 'Starting Context' and/or aren't enthusiastic about 'Target Context'. It doesn't contain any new technical information and can be skipped by anyone who doesn't need any orientation.
Orientation
Here is the list of the UNO components described so far in this series.
Main Body
1: The Specifications
* The types are UNO datum types.
* When a property is identical with another property, the property set later has the precedence.
| Name | Type | Value |
|---|---|---|
| DisplayName | string | the style name |
| WritingMode | short | the script direction: '0' -> left-to-right, top-to-bottom, '1' -> right-to-left, top-to-bottom, '2' -> top-to-bottom, right-to-left |
| Hidden | boolean | the sheet is hidden |
| UserDefinedAttributes | ::com::sun::star::container::XNameContainer | the user defined attributes |
| PageStyleLayout | ::com::sun::star::style::PageStyleLayout | the way how the left page layout and the right page layout are different: 'PageStyleLayout.ALL' -> the left page layout and the right page layout are identical, 'PageStyleLayout.LEFT' -> the contents are shown only in the left pages, 'PageStyleLayout.RIGHT' -> the contents are shown only in the right pages, 'PageStyleLayout.MIRRORED' -> the left page layout and the right page layout are mirrored |
| NumberingType | short | the pages numbering type: '5' -> none, '4' -> '1, 2, 3, . . .', etc. |
| Size | ::com::sun::star::awt::Size | the page size in hundredths of a millimeter |
| Width | long | the page width in hundredths of a millimeter (identical with the width of 'Size') |
| Height | long | the page height in hundredths of a millimeter (identical with the height of 'Size') |
| IsLandscape | boolean | the page is landscape |
| PrinterPaperTray | string | the printer paper tray specification name: '[From printer settings]', 'Automatically Select', etc. |
| LeftMargin | long | the page left margin in hundredths of a millimeter |
| RightMargin | long | the page right margin in hundredths of a millimeter |
| TopMargin | long | the page top margin in hundredths of a millimeter |
| BottomMargin | long | the page bottom margin in hundredths of a millimeter |
| BorderDistance | long | the page borders synchronized padding in hundredths of a millimeter |
| LeftBorderDistance | long | the page left border padding in hundredths of a millimeter |
| RightBorderDistance | long | the page right border padding in hundredths of a millimeter |
| TopBorderDistance | long | the page top border padding in hundredths of a millimeter |
| BottomBorderDistance | long | the page bottom border padding in hundredths of a millimeter |
| LeftBorder | ::com::sun::star::table::BorderLine2 | the page left border |
| RightBorder | ::com::sun::star::table::BorderLine2 | the page right border |
| TopBorder | ::com::sun::star::table::BorderLine2 | the page top border |
| BottomBorder | ::com::sun::star::table::BorderLine2 | the page bottom border |
| BackTransparent | boolean | the page background is transparent (identical with 'IsBackgroundTransparent') |
| BackColor | ::com::sun::star::util::Color | the page background color (identical with 'BackgroundColor') |
| BackGraphicURL | string | the page background graphic URL: like 'vnd.sun.star.GraphicObject:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' when the graphic is not linked |
| BackGraphicLocation | ::com::sun::star::style::GraphicLocation | the page background graphic's location in the page |
| BackGraphicFilter | string | the page background graphic filter name: 'PNG - Portable Network Graphic', etc. |
| ShadowFormat | ::com::sun::star::table::ShadowFormat | the page shadow format |
| HeaderIsOn | boolean | the page header is printed (identical with 'HeaderOn') |
| HeaderIsShared | boolean | the page header is shared among the left pages and the right pages (identical with 'HeaderShared') |
| HeaderIsDynamicHeight | boolean | the page header height is changed implicitly (identical with 'HeaderDynamic') |
| HeaderHeight | long | the page header height in hundredths of a millimeter |
| HeaderLeftMargin | long | the page header left margin in hundredths of a millimeter |
| HeaderRightMargin | long | the page header right margin in hundredths of a millimeter |
| HeaderBodyDistance | long | the page header spacing in hundredths of a millimeter |
| HeaderBorderDistance | long | the page header borders synchronized padding in hundredths of a millimeter |
| HeaderLeftBorderDistance | long | the page header left border padding in hundredths of a millimeter |
| HeaderRightBorderDistance | long | the page header right border padding in hundredths of a millimeter |
| HeaderTopBorderDistance | long | the page header top border padding in hundredths of a millimeter |
| HeaderBottomBorderDistance | long | the page header bottom border padding in hundredths of a millimeter |
| HeaderLeftBorder | ::com::sun::star::table::BorderLine2 | the page header left border |
| HeaderRightBorder | ::com::sun::star::table::BorderLine2 | the page header right border |
| HeaderTopBorder | ::com::sun::star::table::BorderLine2 | the page header top border |
| HeaderBottomBorder | ::com::sun::star::table::BorderLine2 | the page header bottom border |
| HeaderBackTransparent | boolean | the header background is transparent (identical with 'TransparentHeaderBackground') |
| HeaderBackColor | ::com::sun::star::util::Color | the page header background color (identical with 'HeaderBackgroundColor') |
| HeaderBackGraphicURL | string | the page header background graphic URL: like 'vnd.sun.star.GraphicObject:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' when the graphic is not linked |
| HeaderBackGraphicLocation | ::com::sun::star::style::GraphicLocation | the page header background graphic's location in the header |
| HeaderBackGraphicFilter | string | the page header background graphic filter name: 'PNG - Portable Network Graphic', etc. |
| HeaderShadowFormat | ::com::sun::star::table::ShadowFormat | the page header shadow format |
| FooterIsOn | boolean | the page footer is printed (identical with 'FooterOn') |
| FooterIsShared | boolean | the page footer is shared among the left pages and the right pages (identical with 'FooterShared') |
| FooterIsDynamicHeight | boolean | the page footer height is changed implicitly (identical with 'FooterDynamic') |
| FooterHeight | long | the page footer height |
| FooterLeftMargin | long | the page footer left margin in hundredths of a millimeter |
| FooterRightMargin | long | the page footer right margin in hundredths of a millimeter |
| FooterBodyDistance | long | the page footer spacing in hundredths of a millimeter |
| FooterBorderDistance | long | the page footer borders synchronized padding in hundredths of a millimeter |
| FooterLeftBorderDistance | long | the page footer left border padding in hundredths of a millimeter |
| FooterRightBorderDistance | long | the page footer right border padding in hundredths of a millimeter |
| FooterTopBorderDistance | long | the page footer top border padding in hundredths of a millimeter |
| FooterBottomBorderDistance | long | the page footer bottom border padding in hundredths of a millimeter |
| FooterLeftBorder | ::com::sun::star::table::BorderLine2 | the page footer left border |
| FooterRightBorder | ::com::sun::star::table::BorderLine2 | the page footer right border |
| FooterTopBorder | ::com::sun::star::table::BorderLine2 | the page footer top border |
| FooterBottomBorder | ::com::sun::star::table::BorderLine2 | the page footer bottom border |
| FooterBackTransparent | boolean | the page footer background is transparent (identical with 'TransparentFooterBackground') |
| FooterBackColor | ::com::sun::star::util::Color | the page footer background color (identical with 'FooterBackgroundColor') |
| FooterBackGraphicURL | string | the page footer background graphic URL: like 'vnd.sun.star.GraphicObject:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' when the graphic is not linked |
| FooterBackGraphicLocation | ::com::sun::star::style::GraphicLocation | the page footer background graphic's location in the footer |
| FooterBackGraphicFilter | string | the page footer background graphic filter name: 'PNG - Portable Network Graphic', etc. |
| FooterShadowFormat | ::com::sun::star::table::ShadowFormat | the page footer shadow format |
| PrintHeaders | boolean | the row headers and the column headers are printed |
| PrintGrid | boolean | the grid is printed |
| PrintZeroValues | boolean | the zeros are printed |
| PrintObjects | boolean | the auxiliary objects (the Math objects, the OLE objects, the imported charts, and the image objects) are printed |
| PrintFormulas | boolean | the formulae, instead of the values of them, are printed |
| PrintCharts | boolean | the charts are printed |
| PrintDrawing | boolean | the shapes are printed |
| PrintAnnotations | boolean | the comments are printed |
| PrintDownFirst | boolean | the pages are printed downward first |
| FirstPageNumber | short | the first page number |
| PageScale | short | the page scale in % |
| ScaleToPages | short | the number of pages for the print to fit in |
| ScaleToPagesX | short | the horizontal number of pages for the print to fit in |
| ScaleToPagesY | short | the vertical number of pages for the print to fit in |
| CenterHorizontally | boolean | the contents are centered horizontally |
| CenterVertically | boolean | the contents are centered vertically |
| IsBackgroundTransparent | boolean | the page background is transparent (identical with 'BackTransparent') |
| BackgroundColor | ::com::sun::star::util_Color | the page background color (identical with 'BackColor') |
| HeaderOn | boolean | the page header is printed (identical with 'HeaderIsOn') |
| HeaderShared | boolean | the page header is shared among the left pages and the right pages (identical with 'HeaderIsShared') |
| LeftPageHeaderContent | ::com::sun::star::sheet::XHeaderFooterContent | the left page header contents |
| RightPageHeaderContent | ::com::sun::star::sheet::XHeaderFooterContent | the right page header contents |
| HeaderDynamic | boolean | the page header height is changed implicitly (identical with 'HeaderIsDynamicHeight') |
| TransparentHeaderBackground | boolean | the page header background is transparent (identical with 'HeaderBackTransparent') |
| HeaderBackgroundColor | ::com::sun::star::util::Color | the page header background color (identical with 'HeaderBackColor') |
| FooterOn | boolean | the page footer is printed (identical with 'FooterIsOn') |
| FooterShared | boolean | the page footer is shared among the left pages and the right pages (identical with 'FooterIsShared') |
| LeftPageFooterContent | ::com::sun::star::sheet::XHeaderFooterContent | the left page footer contents |
| RightPageFooterContent | ::com::sun::star::sheet::XHeaderFooterContent | the right page footer contents |
| FooterDynamic | boolean | the page footer height is changed implicitly (identical with ’FooterIsDynamicHeight’) |
| TransparentFooterBackground | boolean | the page footer background is transparent (identical with 'FooterBackTransparent') |
| FooterBackgroundColor | ::com::sun::star::util::Color | the page footer background color (identical with 'FooterBackColor') |
<The previous article in this series | The table of contents of this series | The next article in this series>
