ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / XLS file functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
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.
New in version SaaS
Android This function is now available for Android applications.
Android Widget This function is now available in Android widget mode.
iPhone/iPad This function is now available for iPhone/iPad applications.
Syntax
<Result> = xlsDeleteWorksheet(<XLS document> [, <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.
Remarks
  • 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: wd300xls.dll
Minimum version required
  • Version 14
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 06/06/2024

Send a report | Local help