Sancho: Основной текст

2011-09-02T17:54:36Z

Основной текст

New page

<section begin=title /><noinclude>{{DISPLAYTITLE:</noinclude>The Structure of Spreadsheet Documents<noinclude>}}</noinclude><section end=title />{{BreadCrumbL10n}}

{{Documentation/BASICGuideTOC
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=EN/documentation/basic_guide/spreadsheets
|NextPage=EN/documentation/basic_guide/rows_and_columns
|spread=block
}}

The document object of a spreadsheet is based on the <idl>com.sun.star.sheet.SpreadsheetDocument</idl> service. Each of these documents may contain several spreadsheets. In this guide, a table-based document or spreadsheet document is the entire document, whereas a spreadsheet (or sheet for short) is a sheet (table) in the document.

{{VBAnote|Different terminology for spreadsheets and their content is used in VBA and {{OOo}} Basic. Whereas the document object in VBA is called a Workbook and its individual pages Worksheets, they are called SpreadsheetDocument and Sheet in {{OOo}} Basic.}}

== Spreadsheets ==

You can access the individual sheets of a spreadsheet document through the <tt>Sheets</tt> list.

The following examples show you how to access a sheet either through its number or its name.

'''Example 1: access by means of the number (numbering begins with 0)'''

<source lang="oobas">
Dim Doc As Object
Dim Sheet As Object

Doc = ThisComponent
Sheet = Doc.Sheets (0)
</source>

{{Note|<tt>ThisComponent</tt> returns the currently active document.

The expression <code>Doc.Sheets(0)</code> is a Basic simplification of the API call : <code>Doc.getSheets.getByIndex(0)</code>}}

'''Example 2: access by means of the name'''

<source lang="oobas">
Dim Doc As Object
Dim Sheet As Object

Doc = ThisComponent
Sheet = Doc.Sheets.getByName("Sheet 1")
</source>

In the first example, the sheet is accessed by its number (counting begins at 0). In the second example, the sheet is accessed by its name and the <tt>getByName</tt> method.

The <tt>Sheet</tt> object that is obtained by the <tt>getByName</tt> method supports the <idl>com.sun.star.sheet.Spreadsheet</idl> service. In addition to providing several interfaces for editing the content, this service provides the following properties:

;<tt>IsVisible (Boolean)</tt>:value True if the spreadsheet is visible.
;<tt>PageStyle (String)</tt>:name of the page template for the spreadsheet.

=== Renaming Sheets ===

A sheet provides methods <code>getName</code> and <code>setName</code> to read and modify its name. Basic can handle both methods like a property <code>Name</code>. Here we rename the first sheet of the spreadsheet document.

<source lang="oobas">
Dim Doc As Object
Dim Sheet As Object

Doc = ThisComponent
Sheet = Doc.Sheets(0)
Sheet.Name = "First"
</source>

=== Creating and Deleting Sheets ===

The <tt>Sheets</tt> container of a <tt>spreadsheet</tt> document is also used to create and delete individual sheets. The following example uses the <tt>hasByName</tt> method to check if a sheet called '''MySheet''' exists. If it does, the method determines a corresponding object reference by using the <tt>getByName</tt> method and then saves the reference in a variable in <tt>Sheet</tt>. If the corresponding sheet does not exist, it is created by the <tt>createInstance</tt> call and inserted in the spreadsheet document by the <tt>insertByName</tt> method.

<source lang="oobas">
Dim Doc As Object
Dim Sheet As Object

Doc = ThisComponent

If Doc.Sheets.hasByName("MySheet") Then
Sheet = Doc.Sheets.getByName("MySheet")
Else
Sheet = Doc.createInstance("com.sun.star.sheet.Spreadsheet")
Doc.Sheets.insertByName("MySheet", Sheet)
End If
</source>

The <tt>hasByName</tt>, <tt>getByName</tt> and <tt>insertByName</tt> methods are obtained from the <idl>com.sun.star.container.XNameContainer</idl> interface as described in [[Documentation/BASIC Guide/API Intro|Introduction to the API]].

The interface <idl>com.sun.star.sheet.Spreadsheets</idl> provides a better method to create a new sheet: <code>insertNewByName</code>.
It inserts a new sheet with the name specified by the first argument, at the position specified by the second argument.

<source lang="oobas">
Dim Doc As Object

Doc = ThisComponent

Doc.Sheets.insertNewByName("OtherSheet", 2)
</source>

The same interface provides methods <code>moveByName</code> and <code>copyByName</code>.

The <idl>com.sun.star.container.XNameContainer</idl> interface provides a method to remove a sheet of a given name:

<source lang="oobas">
Dim Doc As Object

Doc = ThisComponent

Doc.Sheets.removeByName("OtherSheet")
</source>

{{PDL1}}

EN/documentation/basic guide/structure of spreadsheets - Revision history

Sancho: Основной текст