OpenOffice.org BASIC Guide.pdf - OpenOffice.org wiki

More Than Just Text 116
The example creates a text frame, inserts this in the current document and opens a
TextCursor for the text frame. This cursor is used to set the frame font to bold type and to
set the paragraph orientation to centered. The text frame is finally assigned the “This is a
small test!” string.
Text Fields
Text fields are TextContent objects because they provide additional logic extending beyond
pure text. Text fields can be inserted in a text document using the same methods as those
used for other TextContent objects:
Dim Doc As Object
Dim DateTimeField As Object
Dim Cursor As Object
Doc = StarDesktop.CurrentComponent
Cursor = Doc.Text.createTextCursor()
DateTimeField =
Doc.createInstance("com.sun.star.text.textfield.DateTime")
DateTimeField.IsFixed = False
DateTimeField.IsDate = True
Doc.Text.insertTextContent(Cursor, DateTimeField, False)
The example inserts a text field with the current date at the start of the current text
document. The True value of the IsDate property results in only the date and not time being
displayed. The False value for IsFixed ensures that the date is automatically updated when
the document is opened.
While the type of a field in VBA is specified by a parameter of the Document.Fields.Add method, the
name of the service that is responsible for the field type in question defines it in OpenOffice.org Basic.
In the past, text fields were accessed using a whole range of methods that OpenOffice.org
made available in the old Selection object (for example InsertField, DeleteUserField,
SetCurField).
In OpenOffice.org 2.x, the fields are administered using an object-oriented concept. To
create a text field, a text field 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