Skip to end of metadata
Go to start of metadata

Refresh page Aug 15, 2019 14:47

Supported Clients
SmartClient WebClient NGClient

Property Summary
Boolean exportEnabled Enable the export feature of this plugin.
Boolean importEnabled Enable the import feature of this plugin.

Methods 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 (*.

Property Details

exportEnabled

Enable the export feature of this plugin.

Returns

Supported Clients

SmartClient

Sample

plugins.textxport.exportEnabled = true;
var isEnabled = plugins.textxport.exportEnabled;

importEnabled

Enable the import feature of this plugin.

Returns

Supported Clients

SmartClient

Sample

plugins.textxport.importEnabled = true;
var isEnabled = plugins.textxport.importEnabled;

Methods Details

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

  • No labels