Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)exportEnabled
styleindexdisplay:none

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.

Div
iddescription
This plugin allows the enabling/disabling of the Smart Client menuitems that expose the generic text import/export logic.
classimportEnabled
servoy sSummary12%30%58%height: 30px;3Property SummaryEnable the export feature of this plugin.Enable the import feature of this plugin.servoy sSummary
true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable
id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

Table Cell (td)
Boolean
Table Cell (td)
Table Row (tr)
HTML Table

Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
style
Table Row (tr)
Table Cell (td)
String
Table Cell (td)textExport(foundSet, dataProviderIds)
12%30%58%height: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)textExport(foundSet, dataProviderIds, separator)
3Methods SummaryCreate exporter for easier export set up.Export to text 'separated value' data (*. Table Row (tr)
Table Cell (td)
String
Table Cell (td)textExport(foundSet, dataProviderIds, separator, exportHeader)
Export to text 'separated value' data (*.Export to text 'separated value' data (*.table

id

propertyclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px; Table Head (th)colspan2Property Details Table Body (tbody)ididexportEnabled Table Row (tr)nametdid

exportEnabled

Table Row (tr)des Table Cell (td) DivclasssIndent
Enable the export feature of this plugin.
tr
idret

Table Cell (td)

Returns

divsIndentclients

classid

Supported Clients

sIndent
Boolean Table Row (tr)SmartClientsam

Table Cell (td)

Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idtextExport-JSFoundSet_StringArray
Table Row (tr)
idname
Table Cell (td)

textExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
textExport
Span
(foundSet, dataProviderIds)
Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
Export to text 'separated value' data

Sample

Div
classsIndent
Code Block
languagejavascript
plugins.textxport.exportEnabled = true;
var isEnabled = plugins.textxport.exportEnabled;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idimportEnabled
Table Row (tr)
idname
Table Cell (td)

importEnabled

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Enable the import feature of this plugin.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
plugins.textxport.importEnabled = true;
var isEnabled = plugins.textxport.importEnabled;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
HTML Table
idfunction
classservoy sDetail
sIdentjavascriptlastDetailRowimportEnabledname

importEnabled

dessIndent
Enable the import feature of this plugin.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow

idfunctionservoy sDetail2100%height:30px2Methods DetailscreateExportername

createExporter(foundSet, separator, exportHeader)

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

Parameters

sIndentfoundSetthe foundset to export withseparatorthe separator of the dataexportHeaderexport a header
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
textExportname

textExport(foundSet, dataProviderIds)

dessIndent
Export to text 'separated value' data (*.tab/*.csv)
Table Row (tr)prstdclass

Parameters

DivsIndent{JSFoundSet} foundSet - the foundset to export with
{String[]} dataProviderIds - the ids of the dataproviders Table Row (tr)idtdret

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td)

Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtextExport-JSFoundSet_StringArray_String
Table Row (tr)
idname
Table Cell (td)

textExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
textExport
Span

Sample

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

textExport(foundSet, dataProviderIds, separator)

Table Row (tr)id Table Cell (td) Divclass

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

Table Cell (td)class

Parameters

DivsIndent{JSFoundSet} foundSet - the foundset to export with
{String[]} dataProviderIds - the ids of the dataproviders
{String} separator - the separator of the data Table Row (tr)idtdret

Returns

divsIndentclients

classtd

Supported Clients

sIndent
String Table Row (tr)
idsam
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtextExport-JSFoundSet_StringArray_String_Boolean
Table Row (tr)
idname
Table Cell (td)

textExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
textExport
SpanSmartClient,WebClient,NGClientsam

Sample

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

textExport(foundSet, dataProviderIds, separator, exportHeader)

Table Row (tr)id Table Cell (td) Divclass

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

Parameters

div

classsIndent{JSFoundSet} foundSet - the foundset to export with
{String[]} dataProviderIds - the ids of the dataproviders
{String} separator - the separator of the data
{Boolean} exportHeader - Table Row (tr)idtrue for exporting with the table header, false for nottdret

Returns

divsIndentclients

classid

Supported Clients

sIndent
String Table Row (tr)SmartClient,WebClient,NGClientsam

Table Cell (td) Table Row (tr)

classlastDetailRow
Table Cell (td) 

Sample

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