system.dataset.exportExcel

This function is used in Python Scripting.

Description

Exports the contents of a dataset as an Excel spreadsheet, prompting the user to save the file to disk. Uses the same format as the dataSetToExcel function.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.dataset.exportExcel(filename, showHeaders, dataset[, nullsEmpty])

Parameters

Type	Parameter	Description
String	filename	A suggested filename to save as.
Boolean	showHeaders	If true (1), the spreadsheet will include a header row.
Object[]	dataset	A sequence of datasets, one for each sheet in the resulting workbook.
Boolean	nullsEmpty	New in 7.9.8 If True (1), the spreadsheet will leave cells with NULL values empty, instead of allowing Excel to provide a default value like 0. Defaults to False. [Optional]

Returns

String - The path to the saved file, or None if the action was canceled by the user.

Scope

Client

Code Examples

Example 1

# This snippet would prompt the user to save the data currently displayed in a Table component to an Excel-compatible spreadsheet file, and would open the file after a successful save.
  
table = event.source.parent.getComponent("Table")
filePath = system.dataset.exportExcel("data.xls", 1, table.data)
if filePath != None:
   system.net.openURL("file://"+filePath)