Versions Compared

Key

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


This configuration option allows you to specify a custom function to process CSV and Excel export values one at a time.

Parameters

  • cell info object - an object containing the following properties:
    • value - the original export value
    • bound value formatting - provides binding information, such as field name and data type
    • item properties - provides widget properties from which the value was derived; this allows you to determine the type of widget, the id of the widget, as well as other widget information
    • grid properties - provides information about the grid from which the data is exported
    • record number - the record number currently being exported

Return value

The function should return the adjusted value.

If nothing is returned, or if the value of null or undefined is returned, the original export value will remain unchanged.

Example

Code Block
languagejs
pui["process export value"] = function(cellInfo) {
  // remove line break tags from HTML container exported values
  if (cellInfo["item properties"]["field type"] === "html container") {
    return cellInfo.value.replace(/<br>/g, "");
  }
}