OpenOffice.org BASIC Guide - OpenOffice.org wiki

The Structure of Spreadsheets
The following example activates the automatic height optimization for the first five rows in the sheet and makes
the second column invisible.
Dim Doc As Object
Dim Sheet As Object
Dim Row As Object
Dim Col As Object
Dim I As Integer
Doc = ThisComponent
Sheet = Doc.Sheets(0)
For I = 0 To 4
Row = Sheet.Rows(I)
Row.OptimalHeight = True
Next I
Col = Sheet.Columns(1)
Col.IsVisible = False
Note – The Rows and Columns lists can be accessed through an index in OpenOffice.org Basic. The real API
call is : Sheet.getColumns.getByIndex(1)
Note – VBA : Unlike in VBA, the first column has the index 0 and not the index 1.
Inserting and Deleting Rows and Columns
The Rows and Columns objects of a sheet can access existing rows and columns as well as insert and delete them.
Dim Doc As Object
Dim Sheet As Object
Dim NewColumn As Object
Doc = ThisComponent
Sheet = Doc.Sheets(0)
Sheet.Columns.insertByIndex(3, 1)
Sheet.Columns.removeByIndex(5, 1)
This example uses the insertByIndex method to insert a new column into the fourth column position in the
sheet (index 3 - numbering starts at 0). The second parameter specifies the number of columns to be inserted (in
this example: one).
The removeByIndex method deletes the sixth column (index 5). Again, the second parameter specifies the
number of columns that you want to delete.
The methods for inserting and deleting rows use the Rows object function in the same way as the methods shown
for editing columns using the Columns object.
Cells and Ranges
A spreadsheet consists of a two-dimensional list containing cells. Each cell is defined by its X and Y-position with
respect to the top left cell which has the position (0,0).
Addressing and Editing Individual Cells
The following example creates an object that references the top left cell and inserts a text in the cell:
Dim Doc As Object
Dim Sheet As Object
Dim Cell As Object
Doc = ThisComponent
Sheet = Doc.Sheets(0)
94 OpenOffice.org 3.2 BASIC Guide · March 2010