<Spreadsheet>.InsertWorksheet (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Spreadsheet>.InsertWorksheet (Function)

In french: <Tableur>.InsèreFeuille

Inserts 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 management of several worksheets".
By programming, use MultiWorksheet.

Example

// Insert a worksheet
PSHEET_MySpreadsheet.InsertWorksheet(3, "New worksheet")
// Select the worksheet
PSHEET_MySpreadsheet.CurrentWorksheet = 3

Syntax

<Spreadsheet control>.InsertWorksheet(<Worksheet position> [, <Worksheet name>])

<Spreadsheet control>: Control name

Name of Spreadsheet control to use.

<Worksheet position>: Integer

Position of the worksheet to create.

<Worksheet name>: Optional character string (with quotes)

Name of the worksheet that will be created at the specified position. 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: wd260obj.dll