OpenOffice.org BASIC Guide - OpenOffice.org wiki

Overview of Central Interfaces
basic object. The functions responsible are insertByName, removeByName and replaceByName.
The following is a practical example of this. It calls a text document, which contains a StyleFamilies object
and uses this to in turn make the paragraph templates (ParagraphStyles) of the document available.
Dim StyleFamilies As Object
Dim ParagraphStyles As Object
Dim NewStyle As Object
StyleFamilies = Textdoc.StyleFamilies
ParagraphStyles = StyleFamilies.getByName("ParagraphStyles")
ParagraphStyles.insertByName("NewStyle", NewStyle)
ParagraphStyles.replaceByName("ChangingStyle", NewStyle)
ParagraphStyles.removeByName("OldStyle")
The insertByName line inserts the NewStyle style under the name of the same name in the ParagraphStyles
object. The replaceByName line changes the object behind ChangingStyle into NewStyle. Finally, the
removeByName call removes the object behind OldStyle from ParagraphStyles.
Index-Based Access to Subordinate Objects
The XIndexAccess and XIndexContainer interfaces are used in objects which contain subordinate objects and
which can be addressed using an index.
XIndexAccess provides the methods for accessing individual objects. XIndexContainer provides methods for
inserting and removing elements.
com.sun.star.container.XIndexAccess Interface
XIndexAccess provides the getByIndex and getCount methods for calling the subordinate objects.
getByIndex provides an object with a particular index. getCount returns how many objects are available.
Dim Sheets As Object
Dim Sheet As Object
Dim I As Integer
Sheets = Spreadsheet.Sheets
For I = 0 to Sheets.getCount() - 1
Sheet = Sheets.getByIndex(I)
' Editing sheet
Next I
The example shows a loop that runs through all sheet elements one after another and saves a reference to each in
the Sheet object variable. When working with the indexes, note that getCount returns the number of elements.
The elements in getByIndex however are numbered beginning with 0. The counting variable of the loop
therefore runs from 0 to getCount()-1.
com.sun.star.container.XIndexContainer Interface
The XIndexContainer interface provides the insertByIndex and removeByIndex functions. The parameters
are structured in the same way as the corresponding functions in XNameContainer.
Iterative Access to Subordinate Objects
In some instances, an object may contain a list of subordinate objects that cannot be addressed by either a name
or an index. In these situations, the XEnumeration and XenumerationAccess interfaces are appropriate. They
provide a mechanism through which all subordinate elements of an objects can be passed, step by step, without
having to use direct addressing.
56 OpenOffice.org 3.2 BASIC Guide · March 2010