OpenOffice.org BASIC Guide - OpenOffice.org wiki

More Than Just Text
of the type required should first be created and initialized using the properties required. The text field is then
inserted in the document using the insertTextContent method. A corresponding source text can be seen in
the previous example. The most important field types and their properties are described in the following sections.
In addition to inserting text fields, searching a document for the fields can also be an important task. The
following example shows how all text fields of a text document can be traversed in a loop and checked for their
relevant type.
Dim Doc As Object
Dim TextFieldEnum As Object
Dim TextField As Object
Dim I As Integer
Doc = ThisComponent
TextFieldEnum = Doc.getTextFields.createEnumeration
While TextFieldEnum.hasMoreElements()
Wend
TextField = TextFieldEnum.nextElement()
If TextField.supportsService("com.sun.star.text.textfield.DateTime") Then
MsgBox "Date/time"
ElseIf TextField.supportsService("com.sun.star.text.textfield.Annotation") Then
MsgBox "Annotation"
Else
MsgBox "unknown"
End If
The starting point for establishing the text fields present is the TextFields list of the document object. The
example creates an Enumeration object on the basis of this list, with which all text fields can be queried in turn
in a loop. The text fields found are checked for the service supported using the supportsService method. If
the field proves to be a date/time field or an annotation, then the corresponding field type is displayed in an
information box. If on the other hand, the example encounters another field, then it displays the information
“unknown”.
Below, you will find a list of the most important text fields and their associated properties. A complete list of all
text fields is provided in the API reference in the com.sun.star.text.textfield module. (When listing the
service name of a text field, uppercase and lowercase characters should be used in OpenOffice.org Basic, as in the
previous example.)
Number of Pages, Words and Characters
The text fields
com.sun.star.text.textfield.PageCount
com.sun.star.text.textfield.WordCount
com.sun.star.text.textfield.CharacterCount
return the number of pages, words, or characters of a text. They support the following property:
NumberingType (const)
numbering format (guidelines in accordance with constants from com.sun.star.style.NumberingType).
Current Page
The number of the current page can be inserted in a document using the com.sun.star.text.textfield.PageNumber
text field. The following properties can be specified:
NumberingType (const)
number format (guidelines in accordance with constants from com.sun.star.style.NumberingType).
Offset (short)
offset added to the number of pages (negative specification also possible).
88 OpenOffice.org 3.2 BASIC Guide · March 2010