Summary
The name, the datum type, and the value of each property of text 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 'FillColor') |
| 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 'HeaderFillColor') |
| 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 'FooterFillColor') |
| 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 |
| IsPhysical | boolean | the page style is physical (read only): usually 'true'; unknown how a page style can be un-physical |
| StandardPageMode | boolean | unknown how this is effective |
| FollowStyle | string | the next style name |
| TextVerticalAdjust | com.sun.star.drawing.TextVerticalAdjust | unknown how this is effective |
| RegisterParagraphStyle | string | the name of the paragraph style according to whose spacing the text lines are aligned in an invisible lines grid |
| TextColumns | com.sun.star.text.XTextColumns | the text columns |
| FillStyle | com.sun.star.drawing.FillStyle | the page background style: 'FillStyle.NONE' -> none, 'FillStyle.SOLID' -> solid color, 'FillStyle.GRADIENT' -> gradient, 'FillStyle.HATCH' -> hatch, 'FillStyle.BITMAP' -> graphic or pattern |
| FillBackground | boolean | the page background is filled |
| FillTransparence | short | the page background transparency in % |
| FillTransparenceGradientName | string | the page background transparency gradient name: '' -> nothing, 'Transparency 1', etc. |
| FillTransparenceGradient | com.sun.star.awt.Gradient | the page background transparency gradient |
| FillColor | com.sun.star.util.Color | the page background color (identical with 'BackColor') |
| FillColor2 | com.sun.star.util.Color | the page background 2ndary color; unknown how this is effective |
| FillGradientName | string | the page background color gradient name: seems to be 'gradient' for any gradient type |
| FillGradient | com.sun.star.awt.Gradient | the page background gradient |
| FillGradientStepCount | short | the number of steps of the page background gradient |
| FillBitmapName | string | the page background graphic or pattern name |
| FillBitmapURL | string | the page background graphic URL: like 'vnd.sun.star.GraphicObject:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' |
| FillBitmap | com.sun.star.awt.XBitmap | the page background graphic |
| FillBitmapMode | com.sun.star.drawing.BitmapMode | the page background graphic fitting mode |
| FillBitmapStretch | boolean | the page background graphic is stretched |
| FillBitmapTile | boolean | the page background graphic is tiled |
| FillBitmapPositionOffsetX | long | the page background graphic tiling horizontal offset in % |
| FillBitmapPositionOffsetY | long | the page background graphic tiling vertical offset in % |
| FillBitmapOffsetX | long | the page background graphic tiling horizontal rows shift in % |
| FillBitmapOffsetY | long | the page background graphic tiling horizontal columns shift in % |
| FillBitmapLogicalSize | boolean | the page background graphic size is logical; unknown how this can be 'false' |
| FillBitmapSizeX | long | the page background graphic width in hundredths of a millimeter |
| FillBitmapSizeY | long | the page background graphic height in hundredths of a millimeter |
| FillBitmapRectanglePoint | com.sun.star.drawing.RectanglePoint | the page background graphic's location in the page |
| FillHatchName | string | the page background hatch name |
| FillHatch | com.sun.star.drawing.Hatch | the page background hatch |
| GridDisplay | boolean | the grid is displayed |
| GridPrint | boolean | the grid is printed |
| GridMode | short | the grid mode: '0' -> none, '1' -> the lines, '2' -> the lines and the characters |
| GridSnapToChars | boolean | the grid snaps to the characters; unknown how this can be 'false' |
| GridLines | unsigned short | the number of grid lines |
| GridColor | com.sun.star.util.Color | the grid color |
| GridBaseWidth | long | the grid base text characters maximum width in hundredths of a millimeter |
| GridBaseHeight | long | the grid base text characters maximum height in hundredths of a millimeter |
| GridRubyHeight | long | the grid rubies maximum height in hundredths of a millimeter |
| RubyBelow | boolean | The rubies are shown on the left of or below the base text characters |
| ShadowTransparence | byte | unknown how this is effective |
| FirstIsShared | boolean | the first page does not have any specific header or footer |
| HeaderText | com.sun.star.text.XText | the synchronized header text |
| HeaderTextFirst | com.sun.star.text.XText | the first page header text |
| HeaderTextLeft | com.sun.star.text.XText | the left page header text |
| HeaderTextRight | com.sun.star.text.XText | the right page header text |
| HeaderFillStyle | com.sun.star.drawing.FillStyle | the page header background style: color, hatch, etc. |
| HeaderDynamicSpacing | boolean | the header spacing is changed implicitly |
| HeaderFillBackground | boolean | the page header background is filled |
| HeaderFillTransparence | short | the page header background transparency in % |
| HeaderFillTransparenceGradientName | string | the page header background transparency gradient name: like "Transparency 1" |
| HeaderFillTransparenceGradient | com.sun.star.awt.Gradient | the page header background transparency gradient |
| HeaderFillColor | com.sun.star.util.Color | the page header background color (identical with 'HeaderBackColor') |
| HeaderFillColor2 | com.sun.star.util.Color | the page header background 2ndary color; unknown how this is effective |
| HeaderFillGradientName | string | the page header background gradient name: seems to be 'gradient' for any gradient type |
| HeaderFillGradient | com.sun.star.awt.Gradient | the page header background gradient |
| HeaderFillGradientStepCount | short | the number of the steps of the page header background gradient |
| HeaderFillBitmapName | string | the page header background graphic or pattern name: like 'Sky' |
| HeaderFillBitmapURL | string | the page header background graphic URL: like 'vnd.sun.star.GraphicObject:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' |
| HeaderFillBitmap | com.sun.star.awt.XBitmap | the page header background graphic |
| HeaderFillBitmapMode | com.sun.star.drawing.BitmapMode | the page header background graphic fitting mode |
| HeaderFillBitmapStretch | boolean | the page header background graphic is stretched |
| HeaderFillBitmapTile | boolean | the page header background graphic is tiled |
| HeaderFillBitmapPositionOffsetX | long | the page header background graphic tiling horizontal offset in % |
| HeaderFillBitmapPositionOffsetY | long | the page header background graphic tiling vertical offset in % |
| HeaderFillBitmapOffsetX | long | the page header background graphic tiling rows shift in % |
| HeaderFillBitmapOffsetY | long | the page header background graphic tiling columns shift in % |
| HeaderFillBitmapLogicalSize | boolean | the page header background graphic size is logical; unknown how this can be 'false' |
| HeaderFillBitmapSizeX | long | the page header background graphic width in hundredths of a millimeter |
| HeaderFillBitmapSizeY | long | the page header background graphic height in hundredths of a millimeter |
| HeaderFillBitmapRectanglePoint | com.sun.star.drawing.RectanglePoint | the page header background graphic's location in the header |
| HeaderFillHatchName | string | the page header background hatch name |
| HeaderFillHatch | com.sun.star.drawing.Hatch | the page header background hatch |
| FooterText | com.sun.star.text.Text | the page footer synchronized text |
| FooterTextFirst | com.sun.star.text.Text | the first page footer text |
| FooterTextLeft | com.sun.star.text.Text | the left page footer text |
| FooterTextRight | com.sun.star.text.Text | the right page footer text |
| FooterFillStyle | com.sun.star.drawing.FillStyle | the page footer background style: color, hatch, etc. |
| FooterDynamicSpacing | boolean | the page footer spacing is changed implicitly |
| FooterFillBackground | boolean | the page footer background is filled |
| FooterFillTransparence | short | the page footer background transparency in % |
| FooterFillTransparenceGradientName | string | the page footer background transparency gradient name: like 'Transparency 1' |
| FooterFillTransparenceGradient | com.sun.star.awt.Gradient | the page footer background transparency gradient |
| FooterFillColor | com.sun.star.util.Color | the page footer background color (identical with 'FooterBackColor') |
| FooterFillColor2 | com.sun.star.util.Color | the page footer background 2ndary color; unknown how this is effective |
| FooterFillGradientName | string | the page footer background gradient name: seems to be 'gradient' for any gradient type |
| FooterFillGradient | com.sun.star.awt.Gradient | the page footer background gradient |
| FooterFillGradientStepCount | short | the number of the steps of the page footer background gradient |
| FooterFillBitmapName | string | the page footer background graphic or pattern name: like 'Sky' |
| FooterFillBitmapURL | string | the page footer background graphic URL: like 'vnd.sun.star.GraphicObject:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' |
| FooterFillBitmap | com.sun.star.awt.XBitmap | the page footer background graphic |
| FooterFillBitmapMode | com.sun.star.drawing.BitmapMode | the page footer background graphic fitting mode |
| FooterFillBitmapStretch | boolean | the page footer background graphic is stretched |
| FooterFillBitmapTile | boolean | the page footer background graphic is tiled |
| FooterFillBitmapPositionOffsetX | long | the page footer background graphic tiling horizontal offset in % |
| FooterFillBitmapPositionOffsetY | long | the page footer background graphic tiling vertical offset in % |
| FooterFillBitmapOffsetX | long | the page footer background graphic tiling rows shift in % |
| FooterFillBitmapOffsetY | long | the page footer background graphic tiling columns shift in % |
| FooterFillBitmapLogicalSize | boolean | the page footer background graphic size is logical; unknown how this can be 'false' |
| FooterFillBitmapSizeX | long | the page footer background graphic width |
| FooterFillBitmapSizeY | long | the page footer background graphic height |
| FooterFillBitmapRectanglePoint | com.sun.star.drawing.RectanglePoint | the page footer background graphic's location in the footer |
| FooterFillHatchName | string | the page footer background hatch name |
| FooterFillHatch | com.sun.star.drawing.Hatch | the page footer background hatch |
| FootnoteHeight | long | the footnote maximum height in hundredths of a millimeter |
| FootnoteLineTextDistance | long | the footnote spacing (the space between the footnote separator line and the main body text) in hundredths of a millimeter |
| FootnoteLineStyle | byte | the footnote separator line style: '0' -> none, '1' -> solid, etc. |
| FootnoteLineWeight | short | the footnote separator line weight in hundredths of a millimeter |
| FootnoteLineColor | com.sun.star.util.Color | the footnote separator line color |
| FootnoteLineAdjust | short | the footnote separator line location: '0' -> left, '1' -> center, '2' -> right |
| FootnoteLineRelativeWidth | byte | the footnote separator line relative width in % |
| FootnoteLineDistance | long | the footnote separator line padding (space between the separator line and the footnote contents) in hundredths of a millimeter |
<The previous article in this series | The table of contents of this series | The next article in this series>
