:: com :: sun :: star :: style ::

service PageProperties
Description
describes the style of pages.
Developers Guide
7.4.5 Text Documents - Overall Document Features - Page Layout

Properties' Summary
BackColor contains color of the background.
BackGraphicURL contains the URL of the background graphic.
BackGraphicFilter contains the filter name of the background graphic.
BackGraphicLocation determins the location of the background graphic.
BackTransparent determins if the background color is transparent.
LeftMargin determins the left margin of the page.
RightMargin determins the right margin of the page.
TopMargin determins the top margin of the page.
BottomMargin determins the bottom margin of the page.
LeftBorder determins the left border of the page.
RightBorder determins the right border of the page.
TopBorder determins the top border of the page.
BottomBorder determins the bottom border of the page.
LeftBorderDistance determins the left border distance of the page.
RightBorderDistance determins the right border distance of the page.
TopBorderDistance determins the top border distance of the page.
BottomBorderDistance determins the bottom border distance of the page.
ShadowFormat determins the shadow of the page.
IsLandscape determins if the page format is landscape.
NumberingType determins the default numbering type for this page.
PageStyleLayout determins the layout of the page.
PrinterPaperTray contains the name of a paper tray of the selected printer.
RegisterModeActive [ OPTIONAL ]
determins if the register mode is active on that page.
RegisterParagraphStyle [ OPTIONAL ]
contains the name of the paragraph style that is used as reference of the register mode.
Size contains the paper size of the page.
Width contains the width of the page.
Height contains the height of the page.
TextColumns [ OPTIONAL ]
contains the column settings of the page.
UserDefinedAttributes contains user defined attributes.
HeaderBackColor contains the color of the background of the header.
HeaderBackGraphicURL contains the URL of the background graphic of the header.
HeaderBackGraphicFilter contains the filter name of the background graphic of the header.
HeaderBackGraphicLocation determines the location of the background graphic of the header.
HeaderLeftMargin contains the left margin of the header.
HeaderRightMargin contains the right margin of the header.
HeaderBackTransparent determines if the the background color of the header is transparent.
HeaderLeftBorder determines the left border of the header.
HeaderRightBorder determines the right border of the header.
HeaderTopBorder determines the top border of the header.
HeaderBottomBorder determines the bottom border of the header.
HeaderLeftBorderDistance determines the left border distance of the header.
HeaderRightBorderDistance determines the right border distance of the header.
HeaderTopBorderDistance determines the top border distance of the header.
HeaderBottomBorderDistance determines the bottom border distance of the header.
HeaderShadowFormat determines the shadow of the header.
HeaderBodyDistance determines the distance between the header and the body text area.
HeaderIsShared determines if the header content on left and right pages is the same.
HeaderHeight contains the height of the header.
HeaderIsDynamicHeight determines if the height of the header depends on the content.
HeaderIsOn determines if a header is used on the page.
HeaderText [ OPTIONAL ]
contains the interface to the text of the header.
HeaderTextLeft [ OPTIONAL ]
contains the interface to the text of the header of left pages.
HeaderTextRight [ OPTIONAL ]
contains the interface to the text of the header of right pages.
FooterBackColor contains the color of the background of the footer.
FooterBackGraphicURL contains the URL of the background graphic in the footer.
FooterBackGraphicFilter contains the filter name of the background graphic in the footer.
FooterBackGraphicLocation determines the location of the background graphic in the footer.
FooterLeftMargin determines the left margin of the footer.
FooterRightMargin determines the right margin of the footer.
FooterBackTransparent determines if the background is transparent.
FooterLeftBorder contains the left border of the footer.
FooterRightBorder contains the right border of the footer.
FooterTopBorder contains the top border of the footer.
FooterBottomBorder contains the bottom border of the footer.
FooterLeftBorderDistance contains the left border distance of the footer.
FooterRightBorderDistance contains the right border distance of the footer.
FooterTopBorderDistance contains the top border distance of the footer.
FooterBottomBorderDistance contains the bottom border distance of the footer.
FooterShadowFormat determines the shadow of the footer.
FooterBodyDistance determines the distance between the footer and the body text area.
FooterIsDynamicHeight determines if the height of the footer depends on the content.
FooterIsShared determines if the footer content on left and right pages is the same.
FooterHeight determines the height of the footer.
FooterIsOn determines if a footer is used on the page.
FooterText [ OPTIONAL ]
contains the interface to the text of the footer.
FooterTextLeft [ OPTIONAL ]
contains the interface to the text of the footer of a left page.
FooterTextRight [ OPTIONAL ]
contains .
FootnoteHeight [ OPTIONAL ]
contains the maximum height of the footnote area. If set to zero then the height of the current page is used as limit.
FootnoteLineWeight [ OPTIONAL ]
contains the weight of the separator line between the text and the footnote area.
FootnoteLineColor [ OPTIONAL ]
contains the color of the separator line between the text and the footnote area..
FootnoteLineRelativeWidth [ OPTIONAL ]
contains the relative width of the separator line between the text and the footnote area.
FootnoteLineAdjust [ OPTIONAL ]
contains the adjustment of the separator line between the text and the footnote area.
FootnoteLineTextDistance [ OPTIONAL ]
contains the distance between the text and the separator line between the text and the footnote area.
FootnoteLineDistance [ OPTIONAL ]
contains the distance between the footnote area and the separator line between the text and the footnote area.
WritingMode [ OPTIONAL ]
contains the writing direction, as represented by the ::com::sun::star::text::WritingMode2 constants
GridMode [ OPTIONAL ]
contains the mode of the text grid (none, lines, ...), as represented by ::com::sun::star::text::TextGridMode constants
GridColor [ OPTIONAL ]
contains the display color of the text grid
GridLines [ OPTIONAL ]
contains the number of lines in the text grid
GridBaseHeight [ OPTIONAL ]
contains the height of the base text line inside the text grid
GridRubyHeight [ OPTIONAL ]
contains the height of the ruby text line inside the text grid
GridRubyBelow [ OPTIONAL ]
determines whether the text grid's ruby line is located below or above the base line
GridPrint [ OPTIONAL ]
determines whether the text grid lines are printed
GridDisplay [ OPTIONAL ]
determines whether the text grid lines are visible or not
HeaderDynamicSpacing [ OPTIONAL ]
determines whether to use dynamic spacing in header or not.
FooterDynamicSpacing [ OPTIONAL ]
determines whether to use dynamic spacing in footer or not.
Properties' Details
BackColor
long BackColor;
Description
contains color of the background.
BackGraphicURL
string BackGraphicURL;
Description
contains the URL of the background graphic.
BackGraphicFilter
string BackGraphicFilter;
Description
contains the filter name of the background graphic.
BackGraphicLocation
GraphicLocation BackGraphicLocation;
Description
determins the location of the background graphic.
BackTransparent
boolean BackTransparent;
Description
determins if the background color is transparent.
LeftMargin
long LeftMargin;
Description
determins the left margin of the page.
RightMargin
long RightMargin;
Description
determins the right margin of the page.
TopMargin
long TopMargin;
Description
determins the top margin of the page.
BottomMargin
long BottomMargin;
Description
determins the bottom margin of the page.
LeftBorder
::com::sun::star::table::BorderLine LeftBorder;
Description
determins the left border of the page.
RightBorder
::com::sun::star::table::BorderLine RightBorder;
Description
determins the right border of the page.
TopBorder
::com::sun::star::table::BorderLine TopBorder;
Description
determins the top border of the page.
BottomBorder
::com::sun::star::table::BorderLine BottomBorder;
Description
determins the bottom border of the page.
LeftBorderDistance
long LeftBorderDistance;
Description
determins the left border distance of the page.
RightBorderDistance
long RightBorderDistance;
Description
determins the right border distance of the page.
TopBorderDistance
long TopBorderDistance;
Description
determins the top border distance of the page.
BottomBorderDistance
long BottomBorderDistance;
Description
determins the bottom border distance of the page.
ShadowFormat
::com::sun::star::table::ShadowFormat ShadowFormat;
Description
determins the shadow of the page.
IsLandscape
boolean IsLandscape;
Description
determins if the page format is landscape.
NumberingType
short NumberingType;
Description
determins the default numbering type for this page.
PageStyleLayout
PageStyleLayout PageStyleLayout;
Description
determins the layout of the page.
PrinterPaperTray
string PrinterPaperTray;
Description
contains the name of a paper tray of the selected printer.
RegisterModeActive
boolean RegisterModeActive;
[ OPTIONAL ]
Description
determins if the register mode is active on that page.
RegisterParagraphStyle
string RegisterParagraphStyle;
[ OPTIONAL ]
Description
contains the name of the paragraph style that is used as reference of the register mode.
Size
::com::sun::star::awt::Size Size;
Description
contains the paper size of the page.
Width
long Width;
Description
contains the width of the page.
Height
long Height;
Description
contains the height of the page.
TextColumns
::com::sun::star::text::XTextColumns TextColumns;
[ OPTIONAL ]
Description
contains the column settings of the page.
UserDefinedAttributes
::com::sun::star::container::XNameContainer UserDefinedAttributes;
Description
contains user defined attributes.
HeaderBackColor
long HeaderBackColor;
Description
contains the color of the background of the header.
HeaderBackGraphicURL
string HeaderBackGraphicURL;
Description
contains the URL of the background graphic of the header.
HeaderBackGraphicFilter
string HeaderBackGraphicFilter;
Description
contains the filter name of the background graphic of the header.
HeaderBackGraphicLocation
GraphicLocation HeaderBackGraphicLocation;
Description
determines the location of the background graphic of the header.
HeaderLeftMargin
long HeaderLeftMargin;
Description
contains the left margin of the header.
HeaderRightMargin
long HeaderRightMargin;
Description
contains the right margin of the header.
HeaderBackTransparent
boolean HeaderBackTransparent;
Description
determines if the the background color of the header is transparent.
HeaderLeftBorder
::com::sun::star::table::BorderLine HeaderLeftBorder;
Description
determines the left border of the header.
HeaderRightBorder
::com::sun::star::table::BorderLine HeaderRightBorder;
Description
determines the right border of the header.
HeaderTopBorder
::com::sun::star::table::BorderLine HeaderTopBorder;
Description
determines the top border of the header.
HeaderBottomBorder
::com::sun::star::table::BorderLine HeaderBottomBorder;
Description
determines the bottom border of the header.
HeaderLeftBorderDistance
long HeaderLeftBorderDistance;
Description
determines the left border distance of the header.
HeaderRightBorderDistance
long HeaderRightBorderDistance;
Description
determines the right border distance of the header.
HeaderTopBorderDistance
long HeaderTopBorderDistance;
Description
determines the top border distance of the header.
HeaderBottomBorderDistance
long HeaderBottomBorderDistance;
Description
determines the bottom border distance of the header.
HeaderShadowFormat
::com::sun::star::table::ShadowFormat HeaderShadowFormat;
Description
determines the shadow of the header.
HeaderBodyDistance
long HeaderBodyDistance;
Description
determines the distance between the header and the body text area.
HeaderIsShared
boolean HeaderIsShared;
Description
determines if the header content on left and right pages is the same.
HeaderHeight
long HeaderHeight;
Description
contains the height of the header.
HeaderIsDynamicHeight
boolean HeaderIsDynamicHeight;
Description
determines if the height of the header depends on the content.
HeaderIsOn
boolean HeaderIsOn;
Description
determines if a header is used on the page.
HeaderText
::com::sun::star::text::XText HeaderText;
[ OPTIONAL ]
Description
contains the interface to the text of the header.
HeaderTextLeft
::com::sun::star::text::XText HeaderTextLeft;
[ OPTIONAL ]
Description
contains the interface to the text of the header of left pages.
HeaderTextRight
::com::sun::star::text::XText HeaderTextRight;
[ OPTIONAL ]
Description
contains the interface to the text of the header of right pages.
FooterBackColor
long FooterBackColor;
Description
contains the color of the background of the footer.
FooterBackGraphicURL
string FooterBackGraphicURL;
Description
contains the URL of the background graphic in the footer.
FooterBackGraphicFilter
string FooterBackGraphicFilter;
Description
contains the filter name of the background graphic in the footer.
FooterBackGraphicLocation
GraphicLocation FooterBackGraphicLocation;
Description
determines the location of the background graphic in the footer.
FooterLeftMargin
long FooterLeftMargin;
Description
determines the left margin of the footer.
FooterRightMargin
long FooterRightMargin;
Description
determines the right margin of the footer.
FooterBackTransparent
boolean FooterBackTransparent;
Description
determines if the background is transparent.
FooterLeftBorder
::com::sun::star::table::BorderLine FooterLeftBorder;
Description
contains the left border of the footer.
FooterRightBorder
::com::sun::star::table::BorderLine FooterRightBorder;
Description
contains the right border of the footer.
FooterTopBorder
::com::sun::star::table::BorderLine FooterTopBorder;
Description
contains the top border of the footer.
FooterBottomBorder
::com::sun::star::table::BorderLine FooterBottomBorder;
Description
contains the bottom border of the footer.
FooterLeftBorderDistance
long FooterLeftBorderDistance;
Description
contains the left border distance of the footer.
FooterRightBorderDistance
long FooterRightBorderDistance;
Description
contains the right border distance of the footer.
FooterTopBorderDistance
long FooterTopBorderDistance;
Description
contains the top border distance of the footer.
FooterBottomBorderDistance
long FooterBottomBorderDistance;
Description
contains the bottom border distance of the footer.
FooterShadowFormat
::com::sun::star::table::ShadowFormat FooterShadowFormat;
Description
determines the shadow of the footer.
FooterBodyDistance
long FooterBodyDistance;
Description
determines the distance between the footer and the body text area.
FooterIsDynamicHeight
boolean FooterIsDynamicHeight;
Description
determines if the height of the footer depends on the content.
FooterIsShared
boolean FooterIsShared;
Description
determines if the footer content on left and right pages is the same.
FooterHeight
long FooterHeight;
Description
determines the height of the footer.
FooterIsOn
boolean FooterIsOn;
Description
determines if a footer is used on the page.
FooterText
::com::sun::star::text::XText FooterText;
[ OPTIONAL ]
Description
contains the interface to the text of the footer.
FooterTextLeft
::com::sun::star::text::XText FooterTextLeft;
[ OPTIONAL ]
Description
contains the interface to the text of the footer of a left page.
FooterTextRight
::com::sun::star::text::XText FooterTextRight;
[ OPTIONAL ]
Description
contains .
FootnoteHeight
long FootnoteHeight;
[ OPTIONAL ]
Description
contains the maximum height of the footnote area. If set to zero then the height of the current page is used as limit.
FootnoteLineWeight
short FootnoteLineWeight;
[ OPTIONAL ]
Description
contains the weight of the separator line between the text and the footnote area.
FootnoteLineColor
long FootnoteLineColor;
[ OPTIONAL ]
Description
contains the color of the separator line between the text and the footnote area..
FootnoteLineRelativeWidth
byte FootnoteLineRelativeWidth;
[ OPTIONAL ]
Description
contains the relative width of the separator line between the text and the footnote area.
FootnoteLineAdjust
short FootnoteLineAdjust;
[ OPTIONAL ]
Description
contains the adjustment of the separator line between the text and the footnote area.

::com::sun::star::text::HorizontalAdjust s.

FootnoteLineTextDistance
long FootnoteLineTextDistance;
[ OPTIONAL ]
Description
contains the distance between the text and the separator line between the text and the footnote area.
FootnoteLineDistance
long FootnoteLineDistance;
[ OPTIONAL ]
Description
contains the distance between the footnote area and the separator line between the text and the footnote area.
WritingMode
short WritingMode;
[ OPTIONAL ]
Description
contains the writing direction, as represented by the ::com::sun::star::text::WritingMode2 constants
GridMode
short GridMode;
[ OPTIONAL ]
Description
contains the mode of the text grid (none, lines, ...), as represented by ::com::sun::star::text::TextGridMode constants
GridColor
long GridColor;
[ OPTIONAL ]
Description
contains the display color of the text grid
GridLines
short GridLines;
[ OPTIONAL ]
Description
contains the number of lines in the text grid
GridBaseHeight
long GridBaseHeight;
[ OPTIONAL ]
Description
contains the height of the base text line inside the text grid
GridRubyHeight
long GridRubyHeight;
[ OPTIONAL ]
Description
contains the height of the ruby text line inside the text grid
GridRubyBelow
boolean GridRubyBelow;
[ OPTIONAL ]
Description
determines whether the text grid's ruby line is located below or above the base line
GridPrint
boolean GridPrint;
[ OPTIONAL ]
Description
determines whether the text grid lines are printed
GridDisplay
boolean GridDisplay;
[ OPTIONAL ]
Description
determines whether the text grid lines are visible or not
HeaderDynamicSpacing
boolean HeaderDynamicSpacing;
[ OPTIONAL ]
Description
determines whether to use dynamic spacing in header or not.
FooterDynamicSpacing
boolean FooterDynamicSpacing;
[ OPTIONAL ]
Description
determines whether to use dynamic spacing in footer or not.

 
Top of Page