Overview | Module | Use | Devguide | Index |
Included Services | Exported Interfaces | Properties' Summary | Properties' Details |
service PageProperties |
|
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
|
|
BackGraphicURL
|
|
BackGraphicFilter
|
|
BackGraphicLocation
|
|
BackTransparent
|
|
LeftMargin
|
|
RightMargin
|
|
TopMargin
|
|
BottomMargin
|
|
LeftBorder
|
|
RightBorder
|
|
TopBorder
|
|
BottomBorder
|
|
LeftBorderDistance
|
|
RightBorderDistance
|
|
TopBorderDistance
|
|
BottomBorderDistance
|
|
ShadowFormat
|
|
IsLandscape
|
|
NumberingType
|
|
PageStyleLayout
|
|
PrinterPaperTray
|
|
RegisterModeActive
|
|
RegisterParagraphStyle
|
|
Size
|
|
Width
|
|
Height
|
|
TextColumns
|
|
UserDefinedAttributes
|
|
HeaderBackColor
|
|
HeaderBackGraphicURL
|
|
HeaderBackGraphicFilter
|
|
HeaderBackGraphicLocation
|
|
HeaderLeftMargin
|
|
HeaderRightMargin
|
|
HeaderBackTransparent
|
|
HeaderLeftBorder
|
|
HeaderRightBorder
|
|
HeaderTopBorder
|
|
HeaderBottomBorder
|
|
HeaderLeftBorderDistance
|
|
HeaderRightBorderDistance
|
|
HeaderTopBorderDistance
|
|
HeaderBottomBorderDistance
|
|
HeaderShadowFormat
|
|
HeaderBodyDistance
|
|
HeaderIsShared
|
|
HeaderHeight
|
|
HeaderIsDynamicHeight
|
|
HeaderIsOn
|
|
HeaderText
|
|
HeaderTextLeft
|
|
HeaderTextRight
|
|
FooterBackColor
|
|
FooterBackGraphicURL
|
|
FooterBackGraphicFilter
|
|
FooterBackGraphicLocation
|
|
FooterLeftMargin
|
|
FooterRightMargin
|
|
FooterBackTransparent
|
|
FooterLeftBorder
|
|
FooterRightBorder
|
|
FooterTopBorder
|
|
FooterBottomBorder
|
|
FooterLeftBorderDistance
|
|
FooterRightBorderDistance
|
|
FooterTopBorderDistance
|
|
FooterBottomBorderDistance
|
|
FooterShadowFormat
|
|
FooterBodyDistance
|
|
FooterIsDynamicHeight
|
|
FooterIsShared
|
|
FooterHeight
|
|
FooterIsOn
|
|
FooterText
|
|
FooterTextLeft
|
|
FooterTextRight
|
|
FootnoteHeight
|
|
FootnoteLineWeight
|
|
FootnoteLineColor
|
|
FootnoteLineRelativeWidth
|
|
FootnoteLineAdjust
|
|
FootnoteLineTextDistance
|
|
FootnoteLineDistance
|
|
WritingMode
|
|
GridMode
|
|
GridColor
|
|
GridLines
|
|
GridBaseHeight
|
|
GridRubyHeight
|
|
GridRubyBelow
|
|
GridPrint
|
|
GridDisplay
|
|
HeaderDynamicSpacing
|
|
FooterDynamicSpacing
|
|
BorderDistance
|
|
FooterBorderDistance
|
|
HeaderBorderDistance
|
Copyright © 2003 Sun Microsystems, Inc.