DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

This plugin allows the enabling/disabling of the Smart Client menuitems that expose the generic text import/export logic.



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



Method Summary
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

Boolean

Sample

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

importEnabled

Enable the import feature of this plugin.

Returns

Boolean

Sample

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



Method Details

textExport

String
textExport
(foundSet, dataProviderIds)
Export to text 'separated value' data (*.tab/*.csv)

Parameters

{JSFoundSet} foundSet - the foundset to export with
{String[]} 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

String
textExport
(foundSet, dataProviderIds, separator)
Export to text 'separated value' data (*.tab/*.csv)

Parameters

{JSFoundSet} foundSet - the foundset to export with
{String[]} 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

String
textExport
(foundSet, dataProviderIds, separator, exportHeader)
Export to text 'separated value' data (*.tab/*.csv)

Parameters

{JSFoundSet} foundSet - the foundset to export with
{String[]} 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);