Help / WLanguage / WLanguage functions / Standard functions / XLS file functions
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
<xlsDocument variable>.DeleteWorksheet (Function)
In french: <Variable xlsDocument>.SupprimeFeuille
Deletes a worksheet from the Excel document.
Remark: This document must be handled by an xlsDocument variable and it must be opened in write mode.
<Result> = <XLS document>.DeleteWorksheet([<Worksheet position>])
<Result>: Boolean
  • True is the worksheet was deleted,
  • False if an error occurred. To get more details on the error, use ErrorInfo.
<XLS document>: xlsDocument variable
Name of the xlsDocument variable corresponding to the Excel file to use.
<Worksheet position>: Optional integer
Position of the worksheet to delete (included between 1 and 255).
If this parameter is specified, the specified worksheet is deleted.
If this parameter is not specified, the current worksheet is deleted.
  • To be able to delete a worksheet from an Excel document, there must be at least another worksheet left in the Excel document.
  • If the current worksheet is deleted, the new current worksheet corresponds to the next worksheet or the last worksheet.
  • If the deleted worksheet is found before the current worksheet, the subscript of the current worksheet is decremented by 1 in order to stay on the same worksheet.
Component: wd290xls.dll
Minimum version required
  • Version 24
This page is also available for…
Click [Add] to post a comment

Last update: 06/21/2023

Send a report | Local help