OpenOffice.org BASIC Guide - OpenOffice.org wiki

More Than Just Text
Chapter Name / Number
The name of the current chapter is available through a text field of the com.sun.star.text.textfield.Chapter type.
The form can be defined using two properties.
ChapterFormat (const)
determines whether the chapter name or the chapter number is depicted (in accordance with
com.sun.star.text.ChapterFormat)
Level (Integer)
determines the chapter level whose name and/or chapter number is to be displayed. The value 0 stands for
highest level available.
Bookmarks
Bookmarks (Service com.sun.star.text.Bookmark) are TextContent objects. Bookmarks are created and inserted
using the concept already described previously:
Dim Doc As Object
Dim Bookmark As Object
Dim Cursor As Object
Doc = ThisComponent
Cursor = Doc.Text.createTextCursor()
Bookmark = Doc.createInstance("com.sun.star.text.Bookmark")
Bookmark.Name = "My bookmarks"
Doc.Text.insertTextContent(Cursor, Bookmark, True)
The example creates a Cursor, which marks the insert position of the bookmark and then the actual bookmark
object (Bookmark). The bookmark is then assigned a name and is inserted in the document through
insertTextContent at the cursor position.
The bookmarks of a text are accessed through a list called Bookmarks. The bookmarks can either be accessed by
their number or their name.
The following example shows how a bookmark can be found within a text, and a text inserted at its position.
Dim Doc As Object
Dim Bookmark As Object
Dim Cursor As Object
Doc = ThisComponent
Bookmark = Doc.Bookmarks.getByName("My bookmarks")
Cursor = Doc.Text.createTextCursorByRange(Bookmark.Anchor)
Cursor.String = "Here is the bookmark"
In this example, the getByName method is used to find the bookmark required by means of its name. The
createTextCursorByRange call then creates a Cursor, which is positioned at the anchor position of the
bookmark. The cursor then inserts the text required at this point.
90 OpenOffice.org 3.2 BASIC Guide · March 2010