The Data Export control allows users to export the data from a Table, repeating layout, or a list of complex objects that contain properties of simple types to an Excel .xlsx or .csv formatted file.
Note: The Data Export control does not export data from the Service Data Table control.
Like almost all SPARK controls, you can trigger events that are fired when the user interacts with the control (see the Event and Methods sections below and the Event Handling article for more information).
Behavior
Target Control The path (relative to this control) to the table or repeating layout to use for populating the exported file. This is overridden if the control is bound to data.
Note: As a work-around, if you are experiencing issues with partial export of data, i.e. with paginated Tables, bind the control to the same list variable as the table rather than using the Target Control reference.
Export File Type The file type that is to be exported, .xlsx or .csv
Default File Name The initial file name for the exported file, users can change the file name when saving.
Include Column Headers When checked, the exported file will have column headers. Note: This option has no effect when the control is bound to data.
Tab Index Form control tabbing sequence index. Tab indices start at 1, and may be set sparsely.
Include Hidden Columns Include all columns, regardless of visibility status. By default, columns which are not visible will not be included in the exported file.
Column Formatting Specific config options for exported columns
Appearance
Color Style
Shape Style
Size Style Default, Large, Small, Extra-Small
Outline Only Shows color-based style when hovered over the button
Icon The icon that is displayed on the button, to see a list of available icons, go here: Font Awesome
Width The width of the button, value in px, %, em; for example: 50px, 20%, 0.4em. If no unit is specified, px is assumed
Example
These are the configuration option settings...
Note: The control Id of the Table is Table1
When the page loads...
When the Data Export button is clicked...
This example is using the Chrome browser. Depending on the browser you use, the way the download appears my be different than this example.
When the downloaded file is clicked, it will open in an Excel (.xlsx) document...
Events
With the Data Export control, there are 2 types of event handlers:
- On Load When the page loads
- On Responsive Update When there is a responsive update
You can use JavaScript logic to affect the effects of the control, depending on the event. More information on using these controls can be found in the Event Handling article.
Methods
For detailed information on the available methods for this control, access the JS Doc file.
- Authors: Courtney Silva
- Date Created: March 14, 2016
- Date Modified: March 14, 2016
Comments