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.
{column:width=80px|padding=0px}{column}{column}{column}
Property Summary
exportEnabled
Enable the export feature of this plugin.
importEnabled
Enable the import feature of this plugin.
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
textExport(foundSet, dataProviderIds)
Export to text 'separated value' data (*.
textExport(foundSet, dataProviderIds, separator)
Export to text 'separated value' data (*.
textExport(foundSet, dataProviderIds, separator, exportHeader)
Export to text 'separated value' data (*.
{column:width=100%|padding=0px}{column}
Property Details
Sample
plugins.textxport.exportEnabled = true; var isEnabled = plugins.textxport.exportEnabled;
Sample
plugins.textxport.importEnabled = true; var isEnabled = plugins.textxport.importEnabled;
{column:width=100%|padding=0px}{column}
Method Details
textExport
(foundSet, dataProviderIds)
Parameters
{JSFoundSet} foundSet – the foundset to export with
{String[]} dataProviderIds – the ids of the dataproviders
Sample
//export with default separator(tab) and no header var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name']);
textExport
(foundSet, dataProviderIds, separator)
Parameters
{JSFoundSet} foundSet – the foundset to export with
{String[]} dataProviderIds – the ids of the dataproviders
{String} separator – the separator of the data
Sample
//export with ';' separator and no header var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';');
textExport
(foundSet, dataProviderIds, separator, exportHeader)
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
Sample
//export with ';' separator and header var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';',true);