Export Config
The Predefined Configuration for the Export function
Export State
The Export State contains a list of User Reports, the currently selected report and some properties that allow you to manage Custom Destinations.
| Property | Description |
|---|---|
| CurrentReport | Report currently selected in Export Toolbar and Tool Panel |
| CustomDestinations | User-provided Report Destinations (in addition to those shipped in AdapTable) |
| Reports | User-created Reports; each has Name, Row and Column Scope |
| SystemReportNames | System Reports to use; leave blank for all, empty array for none |
note
The Reports property refers to User Reports; use the SystemReportNames property to set which System Reports will be automatically available to users
Report Object
The Report object has these properties:
| Property | Description |
|---|---|
| CustomReportFunction | Name of User Function to be invoked when running a Custom Report |
| Name | Name of Report - mandatory property |
| ReportColumnScope | Columns to display in Report |
| ReportRowScope | Rows to export when Report runs |
| Scope | Columns Scope; only required if ReportColumnScope is 'ScopeColumns' |
Report Row Scope
The ReportRowScope property defines which rows are included in the report.
The options are:
AllRows - all rows in the DataSource
VisibleRows - all rows in the Grid when the Report is run
note
Includes all filtered rows, i.e. rows not in the current view port but which can be scrolled to
SelectedCells - all cells currently selected
tip
Selected Cells do not need to be contiguous
SelectedRows - all cells in all currently selected rows
tip
Selected Rows do not need to be contiguous
ExpressionRows - the Expression (i.e. Query) to run to evaluate which ows to include in the exported data
CustomRows - used when creating a Custom Report
Report Column Scope
The ReportColumnScope property defines which columns are included in the report.
The options are:
AllColumns - all columns in the DataSource
VisibleColumns - all columns in the Grid when the Report is run
note
Includes all columns that can be scrolled to, even if they are not in the current view port
SelectedColumns - all columns which are currently selected
ScopeColumns - list of Columns provided by the User which uses the Scope object
tip
If the Report is built using the UI Wizard a separate page appears to facilitate this column selection
CustomColumns - used when creating a Custom Report