Page History

{div:style=display: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.\\		\\		Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div}
{div:id=description}This plugin allows the enabling/disabling of the Smart Client menuitems that expose the generic text import/export logic.{div}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{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:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#textExport]\(foundSet, dataProviderIds)
Export to text 'separated value' data (\*.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#textExport]\(foundSet, dataProviderIds, separator)
Export to text 'separated value' data (\*.{td}{tr}{tbody}{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:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=exportEnabled}{tr:id=name}{td}h6.exportEnabled{td}{tr}{tr:id=des}{td}{div:class=sIndent}Enable the export feature of this plugin.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
plugins.textxport.exportEnabled = true;
var isEnabled = plugins.textxport.exportEnabled;
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=importEnabled}{tr:id=name}{td}h6.importEnabled{td}{tr}{tr:id=des}{td}{div:class=sIndent}Enable the import feature of this plugin.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
plugins.textxport.importEnabled = true;
var isEnabled = plugins.textxport.importEnabled;
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ 

{table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=textExport-JSFoundSet_StringArray}{tr:id=name}{td}h6.textExport{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}textExport{span}{span}\(foundSet, dataProviderIds){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Export to text 'separated value' data (\*.tab/\*.csv){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSFoundSet]} foundSet -- the foundset to export with
\{[String]\[]} dataProviderIds -- the ids of the dataproviders
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
//export with default separator(tab) and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name']);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=textExport-JSFoundSet_StringArray_String}{tr:id=name}{td}h6.textExport{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}textExport{span}{span}\(foundSet, dataProviderIds, separator){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Export to text 'separated value' data (\*.tab/\*.csv){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSFoundSet]} foundSet -- the foundset to export with
\{[String]\[]} dataProviderIds -- the ids of the dataproviders
\{[String]} separator -- the separator of the data
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
//export with ';' separator and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';');
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=textExport-JSFoundSet_StringArray_String_Boolean}{tr:id=name}{td}h6.textExport{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}textExport{span}{span}\(foundSet, dataProviderIds, separator, exportHeader){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Export to text 'separated value' data (\*.tab/\*.csv){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
//export with ';' separator and header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';',true);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}