Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

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
Sample
plugins.textxport.exportEnabled = true;
var isEnabled = plugins.textxport.exportEnabled;
importEnabled
Enable the import feature of this plugin.
Returns
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
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
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
Sample
//export with ';' separator and header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';',true);
  • No labels