xlsAddWorksheet (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

xlsAddWorksheet (Function)

In french: xlsAjouteFeuille

Adds or inserts a new worksheet into an Excel document. The added worksheet becomes the current worksheet.

Remark: This document must be handled by an xlsDocument variable and it must be opened in write mode.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

This function is now available for WINDEV applications in Linux.

This function is now available for WEBDEV sites in Linux.

Example

MyXLSDocument is xlsDocument
MyXLSDocument = xlsOpen("C:\Temp\Example.xls", xlsWrite)
IF xlsNbWorksheet(MyXLSDocument) = 1 THEN
xlsAddWorksheet(MyXLSDocument, "MyWorksheet 2")
xlsSave(MyXLSDocument)
END

Syntax

<Result> = xlsAddWorksheet(<XLS document> , <Worksheet name> [, <Worksheet position>])

<Result>: Boolean

True is the worksheet was added,
False if an error occurred. To get the details of the error, use ErrorInfo.
If the addition is performed, the added worksheet becomes the current worksheet.

<XLS document>: xlsDocument variable

Name of xlsDocument variable to use.

<Worksheet name>: Character string (with quotes)

Name of the worksheet that must be added or inserted. This name can contain between 1 and 31 characters. This name is not case sensitive.

<Worksheet position>: Optional integer

Position of the worksheet that must be added (included between 1 and 255).
If this parameter is specified, the worksheet is inserted at the specified position.
If this parameter is specified, the worksheet is added after the existing worksheets.

Component: wd260xls.dll