Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: 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

Apache Software Foundation

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

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