Servoy 2020 Documentation
Child pages
  • textxport

Versions Compared

Old Version 12

changes.mady.by.user Servoy Docs

Saved on

compared with

New Version Current

changes.mady.by.user Servoy Docs

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{hidden} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden} {sub-section:description|text=}This plugin allows the enabling/disabling of the Smart Client menuitems that expose the generic text import/export logic.{sub-section}\\ {table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#exportEnabled] Enable the export feature of this plugin.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#importEnabled] Enable the import feature of this plugin.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#textExport]\(foundSet, dataProviderIds, \[separator\], \[exportHeader\]) Export to text 'separated value' data (\*.{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=exportEnabled|class=node}{tr:id=name}{td}h6.exportEnabled{td}{tr}{tr:id=des}{td}{sub-section:exportEnabled_des|text=|trigger=button}{sub-section}{sub-section:exportEnabled_des|trigger=none|class=sIndent}
Wiki Markup
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Property SummaryEnable the export feature of this plugin.Enable the import feature of this plugin.

servoy sSummary12%30%58%height: 30px;3Methods SummaryCreate exporter for easier export set up.Export to text 'separated value' data (*.Export to text 'separated value' data (*.Export to text 'separated value' data (*.

propertyservoy sDetail2100%height:30px2Property DetailsexportEnabledname

exportEnabled

dessIndent
Enable the export feature of this plugin.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:exportEnabled_snc|text=|trigger=button}{sub-section}{sub-section:exportEnabled_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:exportEnabled_prs|text=|trigger=button}{sub-section}{sub-section:exportEnabled_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:exportEnabled_ret|text=|trigger=button}{sub-section}{sub-section:exportEnabled_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:exportEnabled_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:exportEnabled_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:exportEnabled_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:exportEnabled_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:exportEnabled_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:exportEnabled_sam|trigger=none}{code:language=javascript} plugins.textxport.exportEnabled = true; var isEnabled = plugins.textxport.exportEnabled; {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=importEnabled|class=node}{tr:id=name}{td}h6.importEnabled{td}{tr}{tr:id=des}{td}{sub-section:importEnabled_des|text=|trigger=button}{sub-section}{sub-section:importEnabled_des|trigger=none|class=sIndent}
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowimportEnabledname
importEnabled
dessIndent
Enable the import feature of this plugin.
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:importEnabled_snc|text=|trigger=button}{sub-section}{sub-section:importEnabled_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:importEnabled_prs|text=|trigger=button}{sub-section}{sub-section:importEnabled_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:importEnabled_ret|text=|trigger=button}{sub-section}{sub-section:importEnabled_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:importEnabled_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:importEnabled_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:importEnabled_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:importEnabled_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:importEnabled_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:importEnabled_sam|trigger=none}{code:language=javascript}
plugins.textxport.importEnabled = true;
var isEnabled = plugins.textxport.importEnabled;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\
{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=textExport|class=node}{tr:id=name}{td}h6.textExport{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[String]{span}{span:id=iets|style=float: left; font-weight: bold;}textExport{span}{span:id=iets|style=float: left;}\(foundSet, dataProviderIds, \[separator\], \[exportHeader\]){span}{td}{tr}{tr:id=des}{td}{sub-section:textExport_des|text=|trigger=button}{sub-section}{sub-section:textExport_des|trigger=none|class=sIndent}
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRow
functionservoy 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 headerret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtextExportname
textExport(foundSet, dataProviderIds)
dessIndent
Export to text 'separated value' data (
\
*.tab/
\
*.csv)
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:textExport_snc|text=|trigger=button}{sub-section}{sub-section:textExport_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:textExport_prs|text=|trigger=button}{sub-section}{sub-section:textExport_prs|trigger=none|class=sIndent}foundSet
dataProviderIds
\[separator\]
\[exportHeader\]
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:textExport_ret|text=|trigger=button}{sub-section}{sub-section:textExport_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:textExport_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:textExport_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:textExport_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:textExport_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:textExport_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:textExport_sam|trigger=none}{code:language=javascript}
//export with default separator(tab) and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name']);
//export with ';' separator and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';');
//export with ';' separator and header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';',true);
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
prs
Parameters
sIndentfoundSetthe foundset to export withdataProviderIdsthe ids of the dataprovidersret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtextExportname
textExport(foundSet, dataProviderIds, separator)
dessIndent
Export to text 'separated value' data (*.tab/*.csv)
prs
Parameters
sIndentfoundSetthe foundset to export withdataProviderIdsthe ids of the dataprovidersseparatorthe separator of the dataret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtextExportname
textExport(foundSet, dataProviderIds, separator, exportHeader)
dessIndent
Export to text 'separated value' data (*.tab/*.csv)
prs
Parameters
sIndentfoundSetthe foundset to export withdataProviderIdsthe ids of the dataprovidersseparatorthe separator of the dataexportHeadertrue for exporting with the table header, false for notret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow