Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This method initiates a file download of the grid data in the Excel XLSX file format.  The call to this method can be attached to a button or a similar element's onclick event to initiate the download manually instead of using the "xlsx export" property on the grid, which creates a paging bar with an export link.  The data is output in XLSX (Microsoft Excel Spreadsheet) format.  If the grid's "export with headings" property is set to true, grid headings are exported in addition to the grid data.

Parameters:

  • file - specifies the default file name given to the XLSX file (Optional); the file extension should not be part of this name since ".xlsx" is automatically appended; if the file name parameter is omitted, the id of the grid is used

Example:

Code Block
javascript
getObj("Grid1").grid.exportXLSX("invoices");
Note

Note: This API is available in Profound UI Version 5, Fix Pack 14.1 and newer.