textxport

(plugins.textxport)

Overview

Xport menu enabler

Returned Types

TabExporter,DataProviderExport,

Properties Summarized

Methods Summarized

Type	Name	Summary
TabExporter	createExporter(foundSet, separator, exportHeader)	Create exporter for easier export set up.
String	textExport(foundSet, dataProviderIds)	Export to text 'separated value' data (*.
String	textExport(foundSet, dataProviderIds, separator)	Export to text 'separated value' data (*.
String	textExport(foundSet, dataProviderIds, separator, exportHeader)	Export to text 'separated value' data (*.

Properties Detailed

Methods Detailed

createExporter(foundSet, separator, exportHeader)

Create exporter for easier export set up. Can either use this method (for more complex exports) or textExport(...) API

Parameters

• JSFoundSet foundSet the foundset to export with

• String separator the separator of the data

• Boolean exportHeader export a header

Returns: TabExporter exporter object

Sample

//export with ';' separator and no header
var exporter = plugins.textxport.createExporter(forms.form1.foundset,';',false);

textExport(foundSet, dataProviderIds)

Export to text 'separated value' data (*.tab/*.csv)

Parameters

• JSFoundSet foundSet the foundset to export with

• Array dataProviderIds the ids of the dataproviders

Returns: String

Sample

//export with default separator(tab) and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name']);

textExport(foundSet, dataProviderIds, separator)

Export to text 'separated value' data (*.tab/*.csv)

Parameters

• JSFoundSet foundSet the foundset to export with

• Array dataProviderIds the ids of the dataproviders

• String separator the separator of the data

Returns: String

Sample

//export with ';' separator and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';');

textExport(foundSet, dataProviderIds, separator, exportHeader)

Export to text 'separated value' data (*.tab/*.csv)

Parameters

• JSFoundSet foundSet the foundset to export with

• Array dataProviderIds the ids of the dataproviders

• String separator the separator of the data

• Boolean exportHeader true for exporting with the table header, false for not

Returns: String

Sample

//export with ';' separator and header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';',true);