JavaScript Data GridExcel Export - Extra Content


Prepending and Appending Custom Content

The recommended way to prepend and append content, is by passing an array of ExcelCell objects to prependContent or appendContent. This ensures that the extra content is correctly escaped.

For compatibility with earlier versions of the Grid you can also pass a string, which will be inserted into the file without any processing. You are responsible for formatting the string correctly.

Note the following:

  • You can check and uncheck the checkboxes to add extra content before and after the grid via the prependContent and appendContent properties.

  • With prependContent=ExcelRow[] or appendContent=ExcelRow[], custom content will be inserted containing commas and quotes. These commas and quotes will be visible when opened in Excel because they have been escaped properly.

Export Cover Page

In addition to exporting the Grid in the Excel file, you can also provide additional content on a separate sheet of the Excel file. This can be useful when you'd like to add a cover page to provide your users additional details on the data in this file.

Extra content can also be added in the form of Headers and Footers of the exported Excel file. Please note that this header and footer content is only visible when printing or exporting from Excel to PDF.

You can set header and footer content via the headerFooterConfig: ExcelHeaderFooterConfig object. See it documented further below.

The header and footer object accepts the following placeholders:

  • &[Page]: Prints the current page number.
  • &[Pages]: Prints the total number of pages.
  • &[Date]: Prints the current date.
  • &[Time]: Prints the current time.
  • &[Tab]: Prints the current sheet name.
  • &[Path]: Prints the file path.
  • &[File]: Prints the file name.
  • &[Picture]: Adds an image to the Header or Footer, see more Adding Images to the Header or Footer.

In addition to exporting the Grid as an Excel file, you can also provide pictures on the Header or Footer of the Worksheet. This can be useful when you want to use images as watermark for example. Please note that the watermark image will only be visible in the header & footer view or when printing in Excel.





Next Up

Continue to the next section: Customising Content.