LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
PageProperties Service Referencepublished

describes the style of pages. More...

import"PageProperties.idl";

Inheritance diagram for PageProperties:
PageStyle TablePageStyle

Public Attributes

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

Detailed Description

describes the style of pages.

Developers Guide
Text - Page Layout

Member Data Documentation

com::sun::star::util::Color BackColor
property

contains the background color of the page.

com::sun::star::graphic::XGraphic BackGraphic
optionalproperty

contains the graphic of the background.

Since
LibreOffice 6.1
string BackGraphicFilter
property

contains the filter name of the background graphic.

com::sun::star::style::GraphicLocation BackGraphicLocation
property

determines the location of the background graphic.

string BackGraphicURL
property

contains the URL of the background graphic.

Deprecated:
as of LibreOffice 6.1 - use BackGraphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the BackGraphic property.

boolean BackTransparent
property

determines if the background color is transparent.

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

long BorderDistance
property

determines the distance of all borders of the page.

com::sun::star::table::BorderLine BottomBorder
property

determines the style of the bottom border line of the page.

long BottomBorderDistance
property

determines the bottom border distance of the page.

long BottomMargin
property

determines the bottom margin of the page.

boolean FirstIsShared
optionalpropertymaybevoid

determines if the header/footer content on the first page and remaining pages is the same.

Since
LibreOffice 4.0
com::sun::star::util::Color FooterBackColor
propertymaybevoid

contains the color of the background of the footer.

com::sun::star::graphic::XGraphic FooterBackGraphic
optionalpropertymaybevoid

contains the graphic of the background of the footer.

Since
LibreOffice 6.1
string FooterBackGraphicFilter
propertymaybevoid

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

com::sun::star::style::GraphicLocation FooterBackGraphicLocation
propertymaybevoid

determines the location of the background graphic in the footer.

string FooterBackGraphicURL
propertymaybevoid

contains the URL of the background graphic in the footer.

Deprecated:
as of LibreOffice 6.1 - use FooterBackGraphic

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the FooterBackGraphic property.

boolean FooterBackTransparent
propertymaybevoid

determines if the background of the footer is transparent.

long FooterBodyDistance
propertymaybevoid

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

long FooterBorderDistance
propertymaybevoid

contains the distance of all borders of the footer.

com::sun::star::table::BorderLine FooterBottomBorder
propertymaybevoid

contains the style of the bottom border line of the footer.

long FooterBottomBorderDistance
propertymaybevoid

contains the bottom border distance of the footer.

boolean FooterDynamicSpacing
optionalpropertymaybevoid

determines whether to use dynamic spacing in footer or not.

long FooterHeight
propertymaybevoid

determines the height of the footer.

boolean FooterIsDynamicHeight
propertymaybevoid

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

boolean FooterIsOn
property

determines if a footer is used on the page.

boolean FooterIsShared
propertymaybevoid

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

com::sun::star::table::BorderLine FooterLeftBorder
propertymaybevoid

contains the style of the left border line of the footer.

long FooterLeftBorderDistance
propertymaybevoid

contains the left border distance of the footer.

long FooterLeftMargin
propertymaybevoid

determines the left margin of the footer.

com::sun::star::table::BorderLine FooterRightBorder
propertymaybevoid

contains the style of the right border line of the footer.

long FooterRightBorderDistance
propertymaybevoid

contains the right border distance of the footer.

long FooterRightMargin
propertymaybevoid

determines the right margin of the footer.

com::sun::star::table::ShadowFormat FooterShadowFormat
propertymaybevoid

determines the shadow of the footer.

com::sun::star::text::XText FooterText
optionalpropertymaybevoid

contains the interface to the text of the footer.

com::sun::star::text::XText FooterTextLeft
optionalpropertymaybevoid

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

com::sun::star::text::XText FooterTextRight
optionalpropertymaybevoid

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

com::sun::star::table::BorderLine FooterTopBorder
propertymaybevoid

contains the style of the top border line of the footer.

long FooterTopBorderDistance
propertymaybevoid

contains the top border distance of the footer.

long FootnoteHeight
optionalproperty

contains the maximum height of the footnote area.

If set to zero then the height of the current page is used as limit.

short FootnoteLineAdjust
optionalproperty

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

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

com::sun::star::util::Color FootnoteLineColor
optionalproperty

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

long FootnoteLineDistance
optionalproperty

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

byte FootnoteLineRelativeWidth
optionalproperty

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

short FootnoteLineStyle
optionalproperty

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

See also
com::sun::star::style::FootnoteLineStyle for the possible values.
long FootnoteLineTextDistance
optionalproperty

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

short FootnoteLineWeight
optionalproperty

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

long GridBaseHeight
optionalproperty

contains the height of the base text line inside the text grid

com::sun::star::util::Color GridColor
optionalproperty

contains the display color of the text grid

boolean GridDisplay
optionalproperty

determines whether the text grid lines are visible or not

short GridLines
optionalproperty

contains the number of lines in the text grid

short GridMode
optionalproperty

contains the mode of the text grid (none, lines, ...), as represented by com::sun::star::text::TextGridMode constants

boolean GridPrint
optionalproperty

determines whether the text grid lines are printed

boolean GridRubyBelow
optionalproperty

determines whether the text grid's ruby line is located below or above the base line

long GridRubyHeight
optionalproperty

contains the height of the ruby text line inside the text grid

com::sun::star::util::Color HeaderBackColor
propertymaybevoid

contains the color of the background of the header.

com::sun::star::graphic::XGraphic HeaderBackGraphic
optionalpropertymaybevoid

contains the graphic of the background of the header.

Since
LibreOffice 6.1
string HeaderBackGraphicFilter
propertymaybevoid

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

com::sun::star::style::GraphicLocation HeaderBackGraphicLocation
propertymaybevoid

determines the location of the background graphic of the header.

string HeaderBackGraphicURL
propertymaybevoid

contains the URL of the background graphic of the header.

Deprecated:
as of LibreOffice 6.1 - use HeaderBackGraphic instead

Note the new behaviour since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the HeaderBackGraphic property.

boolean HeaderBackTransparent
propertymaybevoid

determines if the background color of the header is transparent.

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

long HeaderBodyDistance
propertymaybevoid

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

long HeaderBorderDistance
propertymaybevoid

determines the distance of all borders of the header.

com::sun::star::table::BorderLine HeaderBottomBorder
propertymaybevoid

determines the style of the bottom border line of the header.

long HeaderBottomBorderDistance
propertymaybevoid

determines the bottom border distance of the header.

boolean HeaderDynamicSpacing
optionalpropertymaybevoid

determines whether to use dynamic spacing in header or not.

long HeaderHeight
propertymaybevoid

contains the height of the header.

boolean HeaderIsDynamicHeight
propertymaybevoid

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

boolean HeaderIsOn
property

determines if a header is used on the page.

boolean HeaderIsShared
propertymaybevoid

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

com::sun::star::table::BorderLine HeaderLeftBorder
propertymaybevoid

determines the style of the left border line of the header.

long HeaderLeftBorderDistance
propertymaybevoid

determines the left border distance of the header.

long HeaderLeftMargin
propertymaybevoid

contains the left margin of the header.

com::sun::star::table::BorderLine HeaderRightBorder
propertymaybevoid

determines the style of the right border line of the header.

long HeaderRightBorderDistance
propertymaybevoid

determines the right border distance of the header.

long HeaderRightMargin
propertymaybevoid

contains the right margin of the header.

com::sun::star::table::ShadowFormat HeaderShadowFormat
propertymaybevoid

determines the shadow of the header.

com::sun::star::text::XText HeaderText
optionalpropertymaybevoid

contains the interface to the text of the header.

com::sun::star::text::XText HeaderTextLeft
optionalpropertymaybevoid

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

com::sun::star::text::XText HeaderTextRight
optionalpropertymaybevoid

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

com::sun::star::table::BorderLine HeaderTopBorder
propertymaybevoid

determines the style of the top border line of the header.

long HeaderTopBorderDistance
propertymaybevoid

determines the top border distance of the header.

long Height
property

contains the height of the page.

boolean IsLandscape
property

determines if the page format is landscape.

com::sun::star::table::BorderLine LeftBorder
property

determines the style of the left border line of the page.

long LeftBorderDistance
property

determines the left border distance of the page.

long LeftMargin
property

determines the left margin of the page.

short NumberingType
property

determines the default numbering type for this page.

determines the layout of the page.

string PrinterPaperTray
property

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

boolean RegisterModeActive
optionalproperty

determines if the register mode is active on that page.

string RegisterParagraphStyle
optionalproperty

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

com::sun::star::table::BorderLine RightBorder
property

determines the style of the right border line of the page.

long RightBorderDistance
property

determines the right border distance of the page.

long RightMargin
property

determines the right margin of the page.

com::sun::star::table::ShadowFormat ShadowFormat
property

determines the shadow of the page.

contains the paper size of the page.

com::sun::star::text::XTextColumns TextColumns
optionalproperty

contains the column settings of the page.

determines the style of the top border line of the page.

long TopBorderDistance
property

determines the top border distance of the page.

long TopMargin
property

determines the top margin of the page.

com::sun::star::container::XNameContainer UserDefinedAttributes
property

contains user defined attributes.

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

long Width
property

contains the width of the page.

short WritingMode
optionalproperty

contains the writing direction, as represented by the com::sun::star::text::WritingMode2 constants


The documentation for this service was generated from the following file: