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

service PageStyle
Description
contributes common properties of page styles.
See also
::com::sun::star::text::TextPageStyle
See also
::com::sun::star::sheet::TablePageStyle

Included Services
Style
Description
provides common functionality for styles.
Properties' Summary
BackColor contains the background color of the page.
BackTransparent determines whether the background color is transparent.
BackGraphicURL contains the URL of the background graphic.
BackGraphicFilter contains the filter name of the background graphic.
BackGraphicLocation determines the location of the background graphic.
LeftMargin determines the left margin of the page (in 1/100 mm).
RightMargin determines the right margin of the page (in 1/100 mm).
TopMargin determines the top margin of the page (in 1/100 mm).
BottomMargin determines the bottom margin of the page (in 1/100 mm).
LeftBorder determines the style of the left border line of the page.
RightBorder determines the style of the right border line of the page.
TopBorder determines the style of the top border line of the page.
BottomBorder determines the style of the bottom border line of the page.
LeftBorderDistance determines the left border distance of the page (in 1/100 mm).
RightBorderDistance determines the right border distance of the page (in 1/100 mm).
TopBorderDistance determines the top border distance of the page (in 1/100 mm).
BottomBorderDistance determines the bottom border distance of the page (in 1/100 mm).
BorderDistance determines the distance of all borders of the page (in 1/100 mm).
ShadowFormat determines the shadow of the page.
IsLandscape determines if the page format is landscape.
NumberingType determines the default numbering type for this page.
PageStyleLayout determines the layout of the page.
PrinterPaperTray contains the name of a paper tray of the selected printer.
Size contains the paper size of the page.
Width contains the width of the page (in 1/100 mm).
Height contains the height of the page (in 1/100 mm).
UserDefinedAttributes contains user defined attributes.
HeaderBackColor contains the color of the background of the header.
HeaderBackTransparent determines whether the header background color is transparent.
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 (in 1/100 mm).
HeaderRightMargin contains the right margin of the header (in 1/100 mm).
HeaderLeftBorder determines the style of the left border line of the header.
HeaderRightBorder determines the style of the right border line of the header.
HeaderTopBorder determines the style of the top border line of the header.
HeaderBottomBorder determines the style of the bottom border line of the header.
HeaderLeftBorderDistance determines the left border distance of the header (in 1/100 mm).
HeaderRightBorderDistance determines the right border distance of the header (in 1/100 mm).
HeaderTopBorderDistance determines the top border distance of the header (in 1/100 mm).
HeaderBottomBorderDistance determines the bottom border distance of the header (in 1/100 mm).
HeaderBorderDistance determines the distance of all borders of the header (in 1/100 mm).
HeaderBodyDistance determines the distance between the header and the body text area (in 1/100 mm).
HeaderShadowFormat determines the shadow of the header.
HeaderHeight contains the height of the header (in 1/100 mm).
HeaderIsDynamicHeight determines whether the height of the header depends on the content.
HeaderIsShared determines whether the header content on left and right pages is the same.
HeaderIsOn determines whether a header is used on the page.
FooterBackColor contains the color of the background of the footer.
FooterBackTransparent determines whether the background is transparent.
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 (in 1/100 mm).
FooterRightMargin determines the right margin of the footer (in 1/100 mm).
FooterLeftBorder contains the style of the left border line of the footer.
FooterRightBorder contains the style of the right border line of the footer.
FooterTopBorder contains the style of the top border line of the footer.
FooterBottomBorder contains the style of the bottom border line of the footer.
FooterLeftBorderDistance contains the left border distance of the footer (in 1/100 mm).
FooterRightBorderDistance contains the right border distance of the footer (in 1/100 mm).
FooterTopBorderDistance contains the top border distance of the footer (in 1/100 mm).
FooterBottomBorderDistance contains the bottom border distance of the footer (in 1/100 mm).
FooterBorderDistance contains the distance of all borders of the footer (in 1/100 mm).
FooterBodyDistance determines the distance between the footer and the body text area (in 1/100 mm).
FooterShadowFormat determines the shadow of the footer.
FooterHeight determines the height of the footer (in 1/100 mm).
FooterIsDynamicHeight determines whether the height of the footer depends on the content.
FooterIsShared determines whether the footer content on left and right pages is the same.
FooterIsOn determines whether a footer is used on the page.
Properties' Details
BackColor
long BackColor;
Description
contains the background color of the page.
BackTransparent
boolean BackTransparent;
Description
determines whether the background color is transparent.

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

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
determines the location of the background graphic.
LeftMargin
long LeftMargin;
Description
determines the left margin of the page (in 1/100 mm).
RightMargin
long RightMargin;
Description
determines the right margin of the page (in 1/100 mm).
TopMargin
long TopMargin;
Description
determines the top margin of the page (in 1/100 mm).
BottomMargin
long BottomMargin;
Description
determines the bottom margin of the page (in 1/100 mm).
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
determines the left border distance of the page (in 1/100 mm).
RightBorderDistance
long RightBorderDistance;
Description
determines the right border distance of the page (in 1/100 mm).
TopBorderDistance
long TopBorderDistance;
Description
determines the top border distance of the page (in 1/100 mm).
BottomBorderDistance
long BottomBorderDistance;
Description
determines the bottom border distance of the page (in 1/100 mm).
BorderDistance
long BorderDistance;
Description
determines the distance of all borders of the page (in 1/100 mm).
ShadowFormat
::com::sun::star::table::ShadowFormat ShadowFormat;
Description
determines the shadow of the page.
IsLandscape
boolean IsLandscape;
Description
determines if the page format is landscape.
NumberingType
short NumberingType;
Description
determines the default numbering type for this page.
PageStyleLayout
PageStyleLayout PageStyleLayout;
Description
determines the layout of the page.
PrinterPaperTray
string PrinterPaperTray;
Description
contains the name of a paper tray of the selected printer.
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 (in 1/100 mm).
Height
long Height;
Description
contains the height of the page (in 1/100 mm).
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.
HeaderBackTransparent
boolean HeaderBackTransparent;
Description
determines whether the header background color is transparent.

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

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 (in 1/100 mm).
HeaderRightMargin
long HeaderRightMargin;
Description
contains the right margin of the header (in 1/100 mm).
HeaderLeftBorder
::com::sun::star::table::BorderLine HeaderLeftBorder;
Description
determines the style of the left border line of the header.
HeaderRightBorder
::com::sun::star::table::BorderLine HeaderRightBorder;
Description
determines the style of the right border line of the header.
HeaderTopBorder
::com::sun::star::table::BorderLine HeaderTopBorder;
Description
determines the style of the top border line of the header.
HeaderBottomBorder
::com::sun::star::table::BorderLine HeaderBottomBorder;
Description
determines the style of the bottom border line of the header.
HeaderLeftBorderDistance
long HeaderLeftBorderDistance;
Description
determines the left border distance of the header (in 1/100 mm).
HeaderRightBorderDistance
long HeaderRightBorderDistance;
Description
determines the right border distance of the header (in 1/100 mm).
HeaderTopBorderDistance
long HeaderTopBorderDistance;
Description
determines the top border distance of the header (in 1/100 mm).
HeaderBottomBorderDistance
long HeaderBottomBorderDistance;
Description
determines the bottom border distance of the header (in 1/100 mm).
HeaderBorderDistance
long HeaderBorderDistance;
Description
determines the distance of all borders of the header (in 1/100 mm).
HeaderBodyDistance
long HeaderBodyDistance;
Description
determines the distance between the header and the body text area (in 1/100 mm).
HeaderShadowFormat
::com::sun::star::table::ShadowFormat HeaderShadowFormat;
Description
determines the shadow of the header.
HeaderHeight
long HeaderHeight;
Description
contains the height of the header (in 1/100 mm).
HeaderIsDynamicHeight
boolean HeaderIsDynamicHeight;
Description
determines whether the height of the header depends on the content.
HeaderIsShared
boolean HeaderIsShared;
Description
determines whether the header content on left and right pages is the same.
HeaderIsOn
boolean HeaderIsOn;
Description
determines whether a header is used on the page.
FooterBackColor
long FooterBackColor;
Description
contains the color of the background of the footer.
FooterBackTransparent
boolean FooterBackTransparent;
Description
determines whether the background is transparent.
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 (in 1/100 mm).
FooterRightMargin
long FooterRightMargin;
Description
determines the right margin of the footer (in 1/100 mm).
FooterLeftBorder
::com::sun::star::table::BorderLine FooterLeftBorder;
Description
contains the style of the left border line of the footer.
FooterRightBorder
::com::sun::star::table::BorderLine FooterRightBorder;
Description
contains the style of the right border line of the footer.
FooterTopBorder
::com::sun::star::table::BorderLine FooterTopBorder;
Description
contains the style of the top border line of the footer.
FooterBottomBorder
::com::sun::star::table::BorderLine FooterBottomBorder;
Description
contains the style of the bottom border line of the footer.
FooterLeftBorderDistance
long FooterLeftBorderDistance;
Description
contains the left border distance of the footer (in 1/100 mm).
FooterRightBorderDistance
long FooterRightBorderDistance;
Description
contains the right border distance of the footer (in 1/100 mm).
FooterTopBorderDistance
long FooterTopBorderDistance;
Description
contains the top border distance of the footer (in 1/100 mm).
FooterBottomBorderDistance
long FooterBottomBorderDistance;
Description
contains the bottom border distance of the footer (in 1/100 mm).
FooterBorderDistance
long FooterBorderDistance;
Description
contains the distance of all borders of the footer (in 1/100 mm).
FooterBodyDistance
long FooterBodyDistance;
Description
determines the distance between the footer and the body text area (in 1/100 mm).
FooterShadowFormat
::com::sun::star::table::ShadowFormat FooterShadowFormat;
Description
determines the shadow of the footer.
FooterHeight
long FooterHeight;
Description
determines the height of the footer (in 1/100 mm).
FooterIsDynamicHeight
boolean FooterIsDynamicHeight;
Description
determines whether the height of the footer depends on the content.
FooterIsShared
boolean FooterIsShared;
Description
determines whether the footer content on left and right pages is the same.
FooterIsOn
boolean FooterIsOn;
Description
determines whether a footer is used on the page.

 
Top of Page