OpenOffice.org BASIC Guide - OpenOffice.org wiki

The following example shows how the number of pages can be inserted into the footer of a document.
Dim Doc As Object
Dim DateTimeField As Object
Dim PageStyles As Object
Dim StdPage As Object
Dim FooterCursor As Object
Dim PageNumber As Object
Doc = ThisComponent
PageNumber = Doc.createInstance("com.sun.star.text.textfield.PageNumber")
PageNumber.NumberingType = com.sun.star.style.NumberingType.ARABIC
PageStyles = Doc.StyleFamilies.getByName("PageStyles")
StdPage = PageStyles("Default")
StdPage.FooterIsOn = True
FooterCursor = StdPage.FooterTextLeft.Text.createTextCursor()
StdPage.FooterTextLeft.Text.insertTextContent(FooterCursor, PageNumber, False)
More Than Just Text
The example first creates a text field which supports the com.sun.star.text.textfield.PageNumber service. Since the
header and footer lines are defined as part of the page templates of OpenOffice.org, this is initially established
using the list of all PageStyles.
To ensure that the footer line is visible, the FooterIsOn property is set to True. The text field is then inserted in
the document using the associated text object of the left-hand footer line.
Annotations
Annotation fields (com.sun.star.text.textfield.Annotation) can be seen by means of a small yellow symbol in the
text. Clicking on this symbol opens a text field, in which a comment on the current point in the text can be
recorded. An annotation field has the following properties.
Author (String)
name of author.
Content (String)
comment text.
Date (Date)
date on which annotation is written.
Date / Time
A date / time field (com.sun.star.text.textfield.DateTime) represents the current date or the current time. It
supports the following properties:
IsFixed (Boolean)
if True, the time details of the insertion remain unchanged, if False, these are updated each time the
document is opened.
IsDate (Boolean)
if True, the field displays the current date, otherwise the current time.
DateTimeValue (struct)
current content of field (com.sun.star.util.DateTime structure)
NumberFormat (const)
format in which the time or date is depicted.
Chapter 6 · Text Documents 89