Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service PageProperties
Description
describes the style of pages.
Developers Guide
Text - Page Layout

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

If this property is set to true, PageStyle::BackColor will not be used.

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
determines the style of the left border line of the page.
RightBorder
::com::sun::star::table::BorderLine RightBorder;
Description
determines the style of the right border line of the page.
TopBorder
::com::sun::star::table::BorderLine TopBorder;
Description
determines the style of the top border line of the page.
BottomBorder
::com::sun::star::table::BorderLine BottomBorder;
Description
determines the style of the bottom border line 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;
Usage Restrictions
optional
Description
determins if the register mode is active on that page.
RegisterParagraphStyle
string RegisterParagraphStyle;
Usage Restrictions
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;
Usage Restrictions
optional
Description
contains the column settings of the page.
UserDefinedAttributes
::com::sun::star::container::XNameContainer UserDefinedAttributes;
Description
contains user defined attributes.

This ::com::sun::star::container::XNameContainer supports the service ::com::sun::star::xml::AttributeContainer.

HeaderBackColor
[ maybevoid ] ::com::sun::star::util::Color HeaderBackColor;
Description
contains the color of the background of the header.
HeaderBackGraphicURL
[ maybevoid ] string HeaderBackGraphicURL;
Description
contains the URL of the background graphic of the header.
HeaderBackGraphicFilter
[ maybevoid ] string HeaderBackGraphicFilter;
Description
contains the filter name of the background graphic of the header.
HeaderBackGraphicLocation
[ maybevoid ] GraphicLocation HeaderBackGraphicLocation;
Description
determines the location of the background graphic of the header.
HeaderLeftMargin
[ maybevoid ] long HeaderLeftMargin;
Description
contains the left margin of the header.
HeaderRightMargin
[ maybevoid ] long HeaderRightMargin;
Description
contains the right margin of the header.
HeaderBackTransparent
[ maybevoid ] boolean HeaderBackTransparent;
Description
determines if the background color of the header is transparent.

If this property is set to true, PageStyle::HeaderBackColor will not be used.

HeaderLeftBorder
[ maybevoid ] ::com::sun::star::table::BorderLine HeaderLeftBorder;
Description
determines the style of the left border line of the header.
HeaderRightBorder
[ maybevoid ] ::com::sun::star::table::BorderLine HeaderRightBorder;
Description
determines the style of the right border line of the header.
HeaderTopBorder
[ maybevoid ] ::com::sun::star::table::BorderLine HeaderTopBorder;
Description
determines the style of the top border line of the header.
HeaderBottomBorder
[ maybevoid ] ::com::sun::star::table::BorderLine HeaderBottomBorder;
Description
determines the style of the bottom border line of the header.
HeaderLeftBorderDistance
[ maybevoid ] long HeaderLeftBorderDistance;
Description
determines the left border distance of the header.
HeaderRightBorderDistance
[ maybevoid ] long HeaderRightBorderDistance;
Description
determines the right border distance of the header.
HeaderTopBorderDistance
[ maybevoid ] long HeaderTopBorderDistance;
Description
determines the top border distance of the header.
HeaderBottomBorderDistance
[ maybevoid ] long HeaderBottomBorderDistance;
Description
determines the bottom border distance of the header.
HeaderShadowFormat
[ maybevoid ] ::com::sun::star::table::ShadowFormat HeaderShadowFormat;
Description
determines the shadow of the header.
HeaderBodyDistance
[ maybevoid ] long HeaderBodyDistance;
Description
determines the distance between the header and the body text area.
HeaderIsShared
[ maybevoid ] boolean HeaderIsShared;
Description
determines if the header content on left and right pages is the same.
HeaderHeight
[ maybevoid ] long HeaderHeight;
Description
contains the height of the header.
HeaderIsDynamicHeight
[ maybevoid ] 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
[ maybevoid ] ::com::sun::star::text::XText HeaderText;
Usage Restrictions
optional
Description
contains the interface to the text of the header.
HeaderTextLeft
[ maybevoid ] ::com::sun::star::text::XText HeaderTextLeft;
Usage Restrictions
optional
Description
contains the interface to the text of the header of left pages.
HeaderTextRight
[ maybevoid ] ::com::sun::star::text::XText HeaderTextRight;
Usage Restrictions
optional
Description
contains the interface to the text of the header of right pages.
FooterBackColor
[ maybevoid ] ::com::sun::star::util::Color FooterBackColor;
Description
contains the color of the background of the footer.
FooterBackGraphicURL
[ maybevoid ] string FooterBackGraphicURL;
Description
contains the URL of the background graphic in the footer.
FooterBackGraphicFilter
[ maybevoid ] string FooterBackGraphicFilter;
Description
contains the filter name of the background graphic in the footer.
FooterBackGraphicLocation
[ maybevoid ] GraphicLocation FooterBackGraphicLocation;
Description
determines the location of the background graphic in the footer.
FooterLeftMargin
[ maybevoid ] long FooterLeftMargin;
Description
determines the left margin of the footer.
FooterRightMargin
[ maybevoid ] long FooterRightMargin;
Description
determines the right margin of the footer.
FooterBackTransparent
[ maybevoid ] boolean FooterBackTransparent;
Description
determines if the background of the footer is transparent.
FooterLeftBorder
[ maybevoid ] ::com::sun::star::table::BorderLine FooterLeftBorder;
Description
contains the style of the left border line of the footer.
FooterRightBorder
[ maybevoid ] ::com::sun::star::table::BorderLine FooterRightBorder;
Description
contains the style of the right border line of the footer.
FooterTopBorder
[ maybevoid ] ::com::sun::star::table::BorderLine FooterTopBorder;
Description
contains the style of the top border line of the footer.
FooterBottomBorder
[ maybevoid ] ::com::sun::star::table::BorderLine FooterBottomBorder;
Description
contains the style of the bottom border line of the footer.
FooterLeftBorderDistance
[ maybevoid ] long FooterLeftBorderDistance;
Description
contains the left border distance of the footer.
FooterRightBorderDistance
[ maybevoid ] long FooterRightBorderDistance;
Description
contains the right border distance of the footer.
FooterTopBorderDistance
[ maybevoid ] long FooterTopBorderDistance;
Description
contains the top border distance of the footer.
FooterBottomBorderDistance
[ maybevoid ] long FooterBottomBorderDistance;
Description
contains the bottom border distance of the footer.
FooterShadowFormat
[ maybevoid ] ::com::sun::star::table::ShadowFormat FooterShadowFormat;
Description
determines the shadow of the footer.
FooterBodyDistance
[ maybevoid ] long FooterBodyDistance;
Description
determines the distance between the footer and the body text area.
FooterIsDynamicHeight
[ maybevoid ] boolean FooterIsDynamicHeight;
Description
determines if the height of the footer depends on the content.
FooterIsShared
[ maybevoid ] boolean FooterIsShared;
Description
determines if the footer content on left and right pages is the same.
FooterHeight
[ maybevoid ] long FooterHeight;
Description
determines the height of the footer.
FooterIsOn
boolean FooterIsOn;
Description
determines if a footer is used on the page.
FooterText
[ maybevoid ] ::com::sun::star::text::XText FooterText;
Usage Restrictions
optional
Description
contains the interface to the text of the footer.
FooterTextLeft
[ maybevoid ] ::com::sun::star::text::XText FooterTextLeft;
Usage Restrictions
optional
Description
contains the interface to the text of the footer of a left page.
FooterTextRight
[ maybevoid ] ::com::sun::star::text::XText FooterTextRight;
Usage Restrictions
optional
Description
contains .
FootnoteHeight
long FootnoteHeight;
Usage Restrictions
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;
Usage Restrictions
optional
Description
contains the weight of the separator line between the text and the footnote area.
FootnoteLineColor
::com::sun::star::util::Color FootnoteLineColor;
Usage Restrictions
optional
Description
contains the color of the separator line between the text and the footnote area..
FootnoteLineRelativeWidth
byte FootnoteLineRelativeWidth;
Usage Restrictions
optional
Description
contains the relative width of the separator line between the text and the footnote area.
FootnoteLineAdjust
short FootnoteLineAdjust;
Usage Restrictions
optional
Description
contains the adjustment of the separator line between the text and the footnote area.

::com::sun::star::text::HorizontalAdjusts.

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

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.