service PageProperties in module com::sun::star::style::

(Global Index)

Syntax

service PageProperties;

Description

describes the style of pages.

Property 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 determins if the register mode is active on that page.

RegisterParagraphStyle 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 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 contains the interface to the text of the header.

HeaderTextLeft contains the interface to the text of the header of left pages.

HeaderTextRight 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 contains the interface to the text of the footer.

FooterTextLeft contains the interface to the text of the footer of a left page.

FooterTextRight contains .

FootnoteHeight contains the maximum height of the footnote area. If set to zero then the height of the current page is used as limit.

FootnoteLineWeight contains the weight of the separator line between the text and the footnote area.

FootnoteLineColor contains the color of the separator line between the text and the footnote area..

FootnoteLineRelativeWidth contains the relative width of the separator line between the text and the footnote area.

FootnoteLineAdjust contains the adjustment of the separator line between the text and the footnote area.

FootnoteLineTextDistance contains the distance between the text and the separator line between the text and the footnote area.

FootnoteLineDistance contains the distance between the footnote area and the separator line between the text and the footnote area.

Property Details



BackColor

Syntax

long BackColor;

Description

contains color of the background.


BackGraphicURL

Syntax

string BackGraphicURL;

Description

contains the URL of the background graphic.


BackGraphicFilter

Syntax

string BackGraphicFilter;

Description

contains the filter name of the background graphic.


BackGraphicLocation

Syntax

com::sun::star::style::GraphicLocation BackGraphicLocation;

Description

determins the location of the background graphic.


BackTransparent

Syntax

boolean BackTransparent;

Description

determins if the background color is transparent.


LeftMargin

Syntax

long LeftMargin;

Description

determins the left margin of the page.


RightMargin

Syntax

long RightMargin;

Description

determins the right margin of the page.


TopMargin

Syntax

long TopMargin;

Description

determins the top margin of the page.


BottomMargin

Syntax

long BottomMargin;

Description

determins the bottom margin of the page.


LeftBorder

Syntax

com::sun::star::table::BorderLine LeftBorder;

Description

determins the left border of the page.


RightBorder

Syntax

com::sun::star::table::BorderLine RightBorder;

Description

determins the right border of the page.


TopBorder

Syntax

com::sun::star::table::BorderLine TopBorder;

Description

determins the top border of the page.


BottomBorder

Syntax

com::sun::star::table::BorderLine BottomBorder;

Description

determins the bottom border of the page.


LeftBorderDistance

Syntax

long LeftBorderDistance;

Description

determins the left border distance of the page.


RightBorderDistance

Syntax

long RightBorderDistance;

Description

determins the right border distance of the page.


TopBorderDistance

Syntax

long TopBorderDistance;

Description

determins the top border distance of the page.


BottomBorderDistance

Syntax

long BottomBorderDistance;

Description

determins the bottom border distance of the page.


ShadowFormat

Syntax

com::sun::star::table::ShadowFormat ShadowFormat;

Description

determins the shadow of the page.


IsLandscape

Syntax

boolean IsLandscape;

Description

determins if the page format is landscape.


NumberingType

Syntax

short NumberingType;

Description

determins the default numbering type for this page.


PageStyleLayout

Syntax

com::sun::star::style::PageStyleLayout PageStyleLayout;

Description

determins the layout of the page.


PrinterPaperTray

Syntax

string PrinterPaperTray;

Description

contains the name of a paper tray of the selected printer.


RegisterModeActive [ O P T I O N A L ]

Syntax

boolean RegisterModeActive;

Description

determins if the register mode is active on that page.


RegisterParagraphStyle [ O P T I O N A L ]

Syntax

string RegisterParagraphStyle;

Description

contains the name of the paragraph style that is used as reference of the register mode.


Size

Syntax

com::sun::star::awt::Size Size;

Description

contains the paper size of the page.


Width

Syntax

long Width;

Description

contains the width of the page.


Height

Syntax

long Height;

Description

contains the height of the page.


TextColumns [ O P T I O N A L ]

Syntax

com::sun::star::text::XTextColumns TextColumns;

Description

contains the column settings of the page.


UserDefinedAttributes

Syntax

com::sun::star::container::XNameContainer UserDefinedAttributes;

Description

contains user defined attributes.


HeaderBackColor

Syntax

long HeaderBackColor;

Description

contains the color of the background of the header.


HeaderBackGraphicURL

Syntax

string HeaderBackGraphicURL;

Description

contains the URL of the background graphic of the header.


HeaderBackGraphicFilter

Syntax

string HeaderBackGraphicFilter;

Description

contains the filter name of the background graphic of the header.


HeaderBackGraphicLocation

Syntax

com::sun::star::style::GraphicLocation HeaderBackGraphicLocation;

Description

determines the location of the background graphic of the header.


HeaderLeftMargin

Syntax

long HeaderLeftMargin;

Description

contains the left margin of the header.


HeaderRightMargin

Syntax

long HeaderRightMargin;

Description

contains the right margin of the header.


HeaderBackTransparent

Syntax

boolean HeaderBackTransparent;

Description

determines if the the background color of the header is transparent.


HeaderLeftBorder

Syntax

com::sun::star::table::BorderLine HeaderLeftBorder;

Description

determines the left border of the header.


HeaderRightBorder

Syntax

com::sun::star::table::BorderLine HeaderRightBorder;

Description

determines the right border of the header.


HeaderTopBorder

Syntax

com::sun::star::table::BorderLine HeaderTopBorder;

Description

determines the top border of the header.


HeaderBottomBorder

Syntax

com::sun::star::table::BorderLine HeaderBottomBorder;

Description

determines the bottom border of the header.


HeaderLeftBorderDistance

Syntax

long HeaderLeftBorderDistance;

Description

determines the left border distance of the header.


HeaderRightBorderDistance

Syntax

long HeaderRightBorderDistance;

Description

determines the right border distance of the header.


HeaderTopBorderDistance

Syntax

long HeaderTopBorderDistance;

Description

determines the top border distance of the header.


HeaderBottomBorderDistance

Syntax

long HeaderBottomBorderDistance;

Description

determines the bottom border distance of the header.


HeaderShadowFormat

Syntax

com::sun::star::table::ShadowFormat HeaderShadowFormat;

Description

determines the shadow of the header.


HeaderBodyDistance

Syntax

long HeaderBodyDistance;

Description

determines the distance between the header and the body text area.


HeaderIsShared

Syntax

boolean HeaderIsShared;

Description

determines if the header content on left and right pages is the same.


HeaderHeight

Syntax

long HeaderHeight;

Description

contains the height of the header.


HeaderIsDynamicHeight

Syntax

boolean HeaderIsDynamicHeight;

Description

determines if the height of the header depends on the content.


HeaderIsOn

Syntax

boolean HeaderIsOn;

Description

determines if a header is used on the page.


HeaderText [ O P T I O N A L ]

Syntax

com::sun::star::text::XText HeaderText;

Description

contains the interface to the text of the header.


HeaderTextLeft [ O P T I O N A L ]

Syntax

com::sun::star::text::XText HeaderTextLeft;

Description

contains the interface to the text of the header of left pages.


HeaderTextRight [ O P T I O N A L ]

Syntax

com::sun::star::text::XText HeaderTextRight;

Description

contains the interface to the text of the header of right pages.


FooterBackColor

Syntax

long FooterBackColor;

Description

contains the color of the background of the footer.


FooterBackGraphicURL

Syntax

string FooterBackGraphicURL;

Description

contains the URL of the background graphic in the footer.


FooterBackGraphicFilter

Syntax

string FooterBackGraphicFilter;

Description

contains the filter name of the background graphic in the footer.


FooterBackGraphicLocation

Syntax

com::sun::star::style::GraphicLocation FooterBackGraphicLocation;

Description

determines the location of the background graphic in the footer.


FooterLeftMargin

Syntax

long FooterLeftMargin;

Description

determines the left margin of the footer.


FooterRightMargin

Syntax

long FooterRightMargin;

Description

determines the right margin of the footer.


FooterBackTransparent

Syntax

boolean FooterBackTransparent;

Description

determines if the background is transparent.


FooterLeftBorder

Syntax

com::sun::star::table::BorderLine FooterLeftBorder;

Description

contains the left border of the footer.


FooterRightBorder

Syntax

com::sun::star::table::BorderLine FooterRightBorder;

Description

contains the right border of the footer.


FooterTopBorder

Syntax

com::sun::star::table::BorderLine FooterTopBorder;

Description

contains the top border of the footer.


FooterBottomBorder

Syntax

com::sun::star::table::BorderLine FooterBottomBorder;

Description

contains the bottom border of the footer.


FooterLeftBorderDistance

Syntax

long FooterLeftBorderDistance;

Description

contains the left border distance of the footer.


FooterRightBorderDistance

Syntax

long FooterRightBorderDistance;

Description

contains the right border distance of the footer.


FooterTopBorderDistance

Syntax

long FooterTopBorderDistance;

Description

contains the top border distance of the footer.


FooterBottomBorderDistance

Syntax

long FooterBottomBorderDistance;

Description

contains the bottom border distance of the footer.


FooterShadowFormat

Syntax

com::sun::star::table::ShadowFormat FooterShadowFormat;

Description

determines the shadow of the footer.


FooterBodyDistance

Syntax

long FooterBodyDistance;

Description

determines the distance between the footer and the body text area.


FooterIsDynamicHeight

Syntax

boolean FooterIsDynamicHeight;

Description

determines if the height of the footer depends on the content.


FooterIsShared

Syntax

boolean FooterIsShared;

Description

determines if the footer content on left and right pages is the same.


FooterHeight

Syntax

long FooterHeight;

Description

determines the height of the footer.


FooterIsOn

Syntax

boolean FooterIsOn;

Description

determines if a footer is used on the page.


FooterText [ O P T I O N A L ]

Syntax

com::sun::star::text::XText FooterText;

Description

contains the interface to the text of the footer.


FooterTextLeft [ O P T I O N A L ]

Syntax

com::sun::star::text::XText FooterTextLeft;

Description

contains the interface to the text of the footer of a left page.


FooterTextRight [ O P T I O N A L ]

Syntax

com::sun::star::text::XText FooterTextRight;

Description

contains .


FootnoteHeight [ O P T I O N A L ]

Syntax

long FootnoteHeight;

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 [ O P T I O N A L ]

Syntax

short FootnoteLineWeight;

Description

contains the weight of the separator line between the text and the footnote area.


FootnoteLineColor [ O P T I O N A L ]

Syntax

long FootnoteLineColor;

Description

contains the color of the separator line between the text and the footnote area..


FootnoteLineRelativeWidth [ O P T I O N A L ]

Syntax

byte FootnoteLineRelativeWidth;

Description

contains the relative width of the separator line between the text and the footnote area.


FootnoteLineAdjust [ O P T I O N A L ]

Syntax

short FootnoteLineAdjust;

Description

contains the adjustment of the separator line between the text and the footnote area.

HorizontalAdjust s.


FootnoteLineTextDistance [ O P T I O N A L ]

Syntax

long FootnoteLineTextDistance;

Description

contains the distance between the text and the separator line between the text and the footnote area.


FootnoteLineDistance [ O P T I O N A L ]

Syntax

long FootnoteLineDistance;

Description

contains the distance between the footnote area and the separator line between the text and the footnote area.

Top of Page