Export to Excel

From Documentation

Stop.png This article is out of date, please refer to http://books.zkoss.org/wiki/ZK_Spreadsheet_Essentials for more up to date information.


Export ZK Spreadsheet to Excel format

Getting Excel Exporter

ZK Spreadsheet comes with Exporter implementation that allows ZK Spreadsheet contents(the Book) to be exported to the Excel format(xls or xlsx per the Book type). Get Excel exporter using Exporters.getExporter(String) as shown below.

Exporter c = Exporters.getExporter("excel");


Here is an example of ZUML file that displays an Excel book file and has a button to export the entire workbook.

<?page title="ZSS Export to Different File Format" contentType="text/html;charset=UTF-8"?>
<window width="100" height="100%"
		<button id="exportBtn" label="Export All"></button>
	<spreadsheet id="spreadsheet"
		src="/WEB-INF/excel/export/export.xlsx" maxrows="200" maxcolumns="40"
		vflex="1" width="100%">


In composer there is one event handler for export button defined in the above ZUML.

Exporting the entire workbook

To export the entire ZK Spreadsheet workbook contents use Exporter.export(Book, OutputStream) API. You should be able to get Book instance either by importing Excel book file using Importer interface or using Spreadsheet.getBook() API if ZK Spreadsheet component is already initialized with an Excel book file. You should also prepare OutputStream to which Excel format should be written to. For example

	public void onClick$exportBtn(Event evt) throws IOException {
		Book wb = spreadsheet.getBook();
		Exporter c = Exporters.getExporter("excel");
		ByteArrayOutputStream baos = new ByteArrayOutputStream();
		c.export(wb, baos);
		Filedownload.save(baos.toByteArray(), "application/file",

Here I am using Exporters to get Exporter implementation to export ZK Spreadsheet contents to Excel format.

See the full source code for Composer here

Version History

Last Update : 2022/01/19

Version Date Content

All source code listed in this book is at Github.

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.