Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: text ::
service TextPageStyle
Description represents a page style for a text document. This service extends the service ::com::sun::star::style::PageStyle with specific properties for text documents.

Properties' Summary
RegisterModeActive | determins whether 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.
TextColumns | contains the column settings of 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.
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 the interface to the text of the footer of a right page.
FootnoteHeight | contains the maximum height of the footnote area (in 1/100 mm).
FootnoteLineWeight | contains the weight of the separator line between the text and the footnote area (in 1/100 mm).
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 (in percent).
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 (in 1/100 mm).
FootnoteLineDistance | contains the distance between the footnote area and the separator line between the text and the footnote area (in 1/100 mm).

Properties' Details
RegisterModeActive
boolean RegisterModeActive; Description determins whether the register mode is active on that page.
RegisterParagraphStyle
string RegisterParagraphStyle; Description contains the name of the paragraph style that is used as reference of the register mode.
TextColumns
XTextColumns TextColumns; Description contains the column settings of the page.
HeaderText
XText HeaderText; Description contains the interface to the text of the header. See also Text
HeaderTextLeft
XText HeaderTextLeft; Description contains the interface to the text of the header of left pages. See also Text
HeaderTextRight
XText HeaderTextRight; Description contains the interface to the text of the header of right pages. See also Text
FooterText
XText FooterText; Description contains the interface to the text of the footer. See also Text
FooterTextLeft
XText FooterTextLeft; Description contains the interface to the text of the footer of a left page. See also Text
FooterTextRight
XText FooterTextRight; Description contains the interface to the text of the footer of a right page. See also Text
FootnoteHeight
long FootnoteHeight; Description contains the maximum height of the footnote area (in 1/100 mm). If set to zero, the height of the current page is used as limit.
FootnoteLineWeight
short FootnoteLineWeight; Description contains the weight of the separator line between the text and the footnote area (in 1/100 mm).
FootnoteLineColor
long FootnoteLineColor; Description contains the color of the separator line between the text and the footnote area.
FootnoteLineRelativeWidth
byte FootnoteLineRelativeWidth; Description contains the relative width of the separator line between the text and the footnote area (in percent).
FootnoteLineAdjust
short FootnoteLineAdjust; Description contains the adjustment of the separator line between the text and the footnote area. See also HorizontalAdjust
FootnoteLineTextDistance
long FootnoteLineTextDistance; Description contains the distance between the text and the separator line between the text and the footnote area (in 1/100 mm).
FootnoteLineDistance
long FootnoteLineDistance; Description contains the distance between the footnote area and the separator line between the text and the footnote area (in 1/100 mm).

Top of Page

Copyright © 2003 Sun Microsystems, Inc.