De structuur van werkbladdocumenten

From Apache OpenOffice Wiki
Jump to: navigation, search
Book.png

Het document-object van een werkbladdocument is gebaseerd op de service com.sun.star.sheet.SpreadsheetDocument. Elk van deze documenten kan meerdere werkbladen bevatten. In deze gids is een tabel-gebaseerd document of werkbladdocument het gehele document, waar een werkblad (of afgekort: blad ) een werkblad (tabel) in het document is.

Documentation note.png VBA : Voor werkbladdocumenten en hun inhoud wordt in VBA en Apache OpenOffice BASIC een verschillende terminologie gebruikt. Waar het documentobject in VBA een Workbook wordt genoemd en de individuele pagina's Worksheets, worden zij SpreadsheetDocument en Sheet genoemd in Apache OpenOffice BASIC.


Werkbladen

U kunt de individuele werkbladen van een werkbladdocument benaderen via de lijst Sheets.

Het volgende voorbeeld toont u hoe u een werkblad kunt benaderen, ofwel via zijn nummer ofwel via zijn naam.

Voorbeeld 1: toegang door middel van het nummer (nummering begint met 0)

Dim Doc As Object
Dim Blad As Object
 
Doc = ThisComponent
Blad = Doc.Sheets (0)
Documentation note.png ThisComponent geeft het huidige actieve document terug.

De uitdrukking Doc.Sheets(0) is een vereenvoudiging voor BASIC van de aanroep van de API: Doc.getSheets.getByIndex(0)

Voorbeeld 2: toegang door middel van de naam

Dim Doc As Object
Dim Blad As Object
 
Doc = ThisComponent
Blad = Doc.Sheets.getByName("Blad 1")

In het eerste voorbeeld wordt toegang tot het werkblad verkregen via zijn nummer (nummering begint bij 0). In het tweede voorbeeld wordt toegang tot het werkblad verkregen via zijn naam en de methode getByName.

Het object Blad dat wordt verkregen door de methode getByName ondersteunt de service com.sun.star.sheet.Spreadsheet. In aanvulling op het verschaffen van verschillende interfaces voor het bewerken van de inhoud, verschaft deze service de volgende eigenschappen:

IsVisible (Boolean)
waarde True als het werkblad zichtbaar is.
PageStyle (String)
naam van het opmaakprofiel voor de pagina van het werkblad.

Bladen hernoemen

Een blad verschaft de methoden getName en setName om zijn naam te lezen en aan te passen. BASIC kan beide methoden behandelen als de eigenschap Name. Hier geven we het eerste blad van het werkbladdocument een andere naam.

Dim Doc As Object
Dim Blad As Object
 
Doc = ThisComponent
Blad = Doc.Sheets(0)
Blad.Name = "Eerste"

Bladen maken en verwijderen

De container Sheets van een werkblad-document wordt gebruikt om individuele bladen te maken en te verwijderen. Het volgende voorbeeld gebruikt de methode hasByName om te controleren of een blad, genaamd MijnBlad bestaat. Als dat niet het geval is bepaalt de methode een overeenkomstige verwijzing naar het object door de methode getByName te gebruiken en slaat dan de verwijzing op in een variabele in Blad. Als het overeenkomstige blad niet bestaat wordt het gemaakt met behulp van de aanroep createInstance en ingevoegd in het werkbladdocument door de methode insertByName.

Dim Doc As Object
Dim Blad As Object
 
Doc = ThisComponent
 
If Doc.Sheets.hasByName("MijnBlad") Then
   Blad = Doc.Sheets.getByName("MijnBlad")
Else
   Blad = Doc.createInstance("com.sun.star.sheet.Spreadsheet")
   Doc.Sheets.insertByName("MijnBlad", Blad)
End If

De methoden hasByName, getByName en insertByName worden verkregen uit de interface com.sun.star.container.XNameContainer zoals neschreven in Introductie tot de API.

De interface com.sun.star.sheet.Spreadsheets verschaft een betere methode om een nieuw blad te maken: insertNewByName. Het voegt een nieuw blad in met de door het eerste argument gespecificeerde naam, op de door het tweede argument gespecificeerde positie.

Dim Doc As Object
 
Doc = ThisComponent
 
Doc.Sheets.insertNewByName("AnderBlad", 2)

Dezelfde interface verschaft de methoden moveByName en copyByName.

De interface com.sun.star.container.XNameContainer verschaft een methode om een blad met een bepaalde naam te verwijderen:

Dim Doc As Object
 
Doc = ThisComponent
 
Doc.Sheets.removeByName("AnderBlad")


Content on this page is licensed under the Public Documentation License (PDL).
Personal tools