<Spreadsheet>.AddWorksheet (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Spreadsheet>.AddWorksheet (Function)

In french: <Tableur>.AjouteFeuille

Adds a worksheet into a Spreadsheet control found in a window.

Remark: To use this function, the Spreadsheet control must allow the management of several worksheets:

In the window editor: In the "Details" tab of the control description window, check "Allow multiple worksheets".
Through programming, use the MultiWorksheet property.

Example

// Add a worksheet
nWorksheet is int
nWorksheet = PSHEET_MySpreadsheet.AddWorksheet()
// Select the worksheet
PSHEET_MySpreadsheet.CurrentWorksheet = nWorksheet

Syntax

<Result> = <Spreadsheet control>.AddWorksheet([<Worksheet name>])

<Result>: Integer

Number of the worksheet created in the Spreadsheet control.

<Spreadsheet control>: Control name

Name of the Spreadsheet control to be used.

<Worksheet name>: Optional character string

Name of the worksheet to create. If this parameter is not specified, the worksheet is created with a default name ("WorksheetX"). This name:
appears in the tab used to select the worksheet (at the bottom of the Spreadsheet control).
is used to identify the worksheet in the formulas. For example, a formula that is using a cell of "Worksheet2" can be: "=SUM(Worksheet2!B4:D4)".

Remarks

The function fails and displays a WLanguage error in the following cases:
- The Spreadsheet control does not manage several worksheets.
- The name of the worksheet is invalid or it is already used by another worksheet.
This function can only be used on a Spreadsheet control found in a window.

Component: wd270obj.dll