Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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 Excel import/export logic



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
Enable the export feature of this plugin.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
importEnabled
Enable the import feature of this plugin.



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
excelExport(foundSet, dataProviderIds)
Export to Excel data
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
excelExport(foundSet, dataProviderIds, templateXLS)
Export to Excel data
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
excelExport(foundSet, dataProviderIds, templateXLS, sheetName)
Export to Excel data
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
excelExport(foundSet, dataProviderIds, templateXLS, sheetName, startRow)
Export to Excel data
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
excelExport(foundSet, dataProviderIds, templateXLS, sheetName, startRow, startColumn)
Export to Excel data



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
idexportEnabled
Table Row (tr)
idname
Table Cell (td)

exportEnabled

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Enable the export 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.excelxport.exportEnabled = true;
var isEnabled = plugins.excelxport.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.excelxport.importEnabled = true;
var isEnabled = plugins.excelxport.importEnabled;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



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

excelExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
excelExport
Span
(foundSet, dataProviderIds)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Export to Excel data
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundSet - the foundset on which to export
{String[]} dataProviderIds - the ids of the dataproviders
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
byte[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//export in new byte array
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name']);
//export by adding to templateXLS in default (new) 'Servoy Data' worksheet
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS);
//export by adding to templateXLS, in 'mySheet' worksheet, starting at default(1/1) row/column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet');
//export by adding to templateXLS, in 'mySheet' worksheet, starting at 3rd row and 5th column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet',3,5);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexcelExport-JSFoundSet_StringArray_byteArray
Table Row (tr)
idname
Table Cell (td)

excelExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
excelExport
Span
(foundSet, dataProviderIds, templateXLS)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Export to Excel data
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundSet - the foundset on which to export
{String[]} dataProviderIds - the ids of the dataproviders
{byte[]} templateXLS - the xls template to export in
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
byte[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//export in new byte array
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name']);
//export by adding to templateXLS in default (new) 'Servoy Data' worksheet
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS);
//export by adding to templateXLS, in 'mySheet' worksheet, starting at default(1/1) row/column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet');
//export by adding to templateXLS, in 'mySheet' worksheet, starting at 3rd row and 5th column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet',3,5);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexcelExport-JSFoundSet_StringArray_byteArray_String
Table Row (tr)
idname
Table Cell (td)

excelExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
excelExport
Span
(foundSet, dataProviderIds, templateXLS, sheetName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Export to Excel data
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundSet - the foundset on which to export
{String[]} dataProviderIds - the ids of the dataproviders
{byte[]} templateXLS - the xls template to export in
{String} sheetName - the name of the worksheet
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
byte[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//export in new byte array
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name']);
//export by adding to templateXLS in default (new) 'Servoy Data' worksheet
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS);
//export by adding to templateXLS, in 'mySheet' worksheet, starting at default(1/1) row/column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet');
//export by adding to templateXLS, in 'mySheet' worksheet, starting at 3rd row and 5th column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet',3,5);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexcelExport-JSFoundSet_StringArray_byteArray_String_Number
Table Row (tr)
idname
Table Cell (td)

excelExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
excelExport
Span
(foundSet, dataProviderIds, templateXLS, sheetName, startRow)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Export to Excel data
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundSet - the foundset on which to export
{String[]} dataProviderIds - the ids of the dataproviders
{byte[]} templateXLS - the xls template to export in
{String} sheetName - the name of the worksheet
{Number} startRow - row in the foundset at which to start the export
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
byte[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//export in new byte array
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name']);
//export by adding to templateXLS in default (new) 'Servoy Data' worksheet
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS);
//export by adding to templateXLS, in 'mySheet' worksheet, starting at default(1/1) row/column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet');
//export by adding to templateXLS, in 'mySheet' worksheet, starting at 3rd row and 5th column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet',3,5);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexcelExport-JSFoundSet_StringArray_byteArray_String_Number_Number
Table Row (tr)
idname
Table Cell (td)

excelExport

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
excelExport
Span
(foundSet, dataProviderIds, templateXLS, sheetName, startRow, startColumn)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Export to Excel data
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundSet - the foundset on which to export
{String[]} dataProviderIds - the ids of the dataproviders
{byte[]} templateXLS - the xls template to export in
{String} sheetName - the name of the worksheet
{Number} startRow - row in the foundset at which to start the export
{Number} startColumn - column in the foundset at which to start the export
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
byte[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//export in new byte array
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name']);
//export by adding to templateXLS in default (new) 'Servoy Data' worksheet
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS);
//export by adding to templateXLS, in 'mySheet' worksheet, starting at default(1/1) row/column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet');
//export by adding to templateXLS, in 'mySheet' worksheet, starting at 3rd row and 5th column
var bytes = plugins.excelxport.excelExport(forms.form1.foundset, ['id','name'],templateXLS, 'mySheet',3,5);
Table Row (tr)
classlastDetailRow
Table Cell (td)