system.dataset.exportCSV

This function is used in Python Scripting.

Description

Exports the contents of a dataset as a CSV file, prompting the user to save the file to disk.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.dataset.exportCSV(filename, showHeaders, dataset)

Parameters

Type	Parameter	Description
String	filename	A suggested filename to save as.
Boolean	showHeaders	If true (1), the CSV file will include a header row.
Dataset	dataset	The dataset to export.

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 a CSV file, and would open the file (in an external program, presumably Excel) after a successful save.
  
table = event.source.parent.getComponent("Table")
filePath = system.dataset.exportCSV("data.csv", 1, table.data)
if filePath != None:
    system.net.openURL("file:///"+filePath.replace('\\','/'))