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

Overview of Central Interfaces 73
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.
com. sun. star. container. XEnumeration and XenumerationAccess
Interfaces
The basic object must provide the XEnumerationAccess interface, which contains only a
createEnumeration method. This returns an auxiliary object, which in turn provides the
XEnumeration interface with the hasMoreElements and nextElement methods. Through
these, you then have access to the subordinate objects.
The following example steps through all the paragraphs of a text:
Dim ParagraphEnumeration As Object
Dim Paragraph As Object
ParagraphEnumeration = Textdoc.Text.createEnumeration
While ParagraphEnumeration.hasMoreElements()
Paragraph = ParagraphEnumeration.nextElement()
Wend
The example first creates a ParagraphEnumeration auxiliary object. This gradually returns
the individual paragraphs of the text in a loop. The loop is terminated as soon as the
hasMoreElements method returns the False value, signaling that the end of the text has
been reached.