OpenOffice.org BASIC Guide - OpenOffice.org wiki

Doc = ThisComponent
Page = Doc.DrawPages(0)
Page.Name = "First"
Creating and Deleting Pages
The Structure of Drawings
The DrawPages container of a drawing document is also used to create and delete individual pages. The
following example uses the hasByName method to check if a page called MyPage exists. If it does, the method
determines a corresponding object reference by using the getByName method and then saves the reference in a
variable in Page. If the corresponding page does not exist, it is created and inserted in the drawing document by
the insertNewByIndex method. The argument of the method is the position, counted from 0, of the existing
page after which the new page will be inserted. Then the new page is renamed.
Dim Doc As Object
Dim Page As Object
Doc = ThisComponent
If Doc.Drawpages.hasByName("MyPage") Then
Page = Doc.Drawpages.getByName("MyPage")
Else
Page = Doc.Drawpages.insertNewByIndex(2)
Page.Name = "MyPage" ' you should always rename a new page
' MyPage is the fourth page of the document, i.e. position 3
End If
The hasByName and getByName methods are obtained from the com.sun.star.container.XNameAccess interface.
The insertNewByIndex method is obtained from the com.sun.star.drawing.XDrawPages interface. The same
interface provides the method remove to delete (remove) a page:
Dim Doc As Object
Doc = ThisComponent
If Doc.Drawpages.hasByName("MyPage") Then
Page = Doc.Drawpages.getByName("MyPage")
Doc.Drawpages.remove(Page)
End If
Duplicating a Page
A copy of a given page is created, not from the DrawPages container, but from the drawing document itself with
the method duplicate. The copy is created at the next position after the original page, with a default name.
Dim Doc As Object
Dim Page As Object, ClonedPage As Object
Doc = ThisComponent
Page = Doc.Drawpages.getByName("MyPage")
ClonedPage = Doc.duplicate(Page)
ClonedPage.Name = "MyCopy" ' you should always rename a new page
Moving a Page
The API does not provide a method to change the position of a page inside a drawing document.
Elementary Properties of Drawing Objects
Drawing objects include shapes (rectangles, circles, and so on), lines, and text objects. All of these share a number
of common features and support the com.sun.star.drawing.Shape service. This service defines the Size
and Position properties of a drawing object.
OpenOffice.org Basic also offers several other services through which you can modify such properties, as
formatting or apply fills. The formatting options that are available depend on the type of drawing object.
Chapter 8 · Drawings and Presentations 113