Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » text

Overview

Module

Use

Devguide

Index

Services' Summary

Interfaces' Summary

Properties' Summary

Services' Details

Interfaces' Details

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
boolean RegisterModeActive	determins whether the register mode is active on that page.
string RegisterParagraphStyle	contains the name of the paragraph style that is used as reference of the register mode.
XTextColumns TextColumns	contains the column settings of the page.
XText HeaderText	contains the interface to the text of the header.
XText HeaderTextLeft	contains the interface to the text of the header of left pages.
XText HeaderTextRight	contains the interface to the text of the header of right pages.
XText FooterText	contains the interface to the text of the footer.
XText FooterTextLeft	contains the interface to the text of the footer of a left page.
XText FooterTextRight	contains the interface to the text of the footer of a right page.
long FootnoteHeight	contains the maximum height of the footnote area (in 1/100 mm).
short FootnoteLineWeight	contains the weight of the separator line between the text and the footnote area (in 1/100 mm).
::com::sun::star::util::Color FootnoteLineColor	contains the color of the separator line between the text and the footnote area.
byte FootnoteLineRelativeWidth	contains the relative width of the separator line between the text and the footnote area (in percent).
short FootnoteLineAdjust	contains the adjustment of the separator line between the text and the footnote area.
long FootnoteLineTextDistance	contains the distance between the text and the separator line between the text and the footnote area (in 1/100 mm).
long 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 ::com::sun::star::util::Color 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 © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The ASF logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.