flexiciousNmsp.ExportOptions Class
Class to export the datagrid, either one page at a time or specific pages, or all pages.
Constructor
flexiciousNmsp.ExportOptions
()
Item Index
Properties
availableColumns
ArrayCollection
A list of exportable columns
Default: []
columnsToExport
ArrayCollection
A list of columns to export
Default: []
copyToClipboard
Boolean
Flag to copy the buffer to clipboard, instead of sending it to the server/disk.
Default: false
echoUrl
String
A URL that the export infrastructure uses to trigger a file download. The various exporters (Doc,CSV,TXT,HTML) basically build a string to export and post it to this url along with the content type and the file extension This is the url to a server that simply writes back the content to the client along with the mime type and content disposition headers.
C# code to do this follows (Java and PHP would do the same thing). Response.AddHeader("content-disposition", string.Format("attachment; filename=Download.{0}",Request["extension"])); Response.ContentType = Request["contentType"]; Response.Write(Request["body"]); Response.End(); Defaults to: http://www.flexicious.com/Home/Echo It is recommended you provide your own echo URL.
Default: http://www.flexicious.com/Home/Echo
enableLocalFilePersistence
Boolean
Flag to enable local file persistence. Defaults to true for Flex 4.
Default: true
exportAllRecords
Boolean
If set to true, exports all the records, irrespective of the filter and paging functions. Please note, for this to work, the dataprovider for the grid MUST be an Array Collection
Default: false
exporters
Array
A list of exporters that are responsible for handling each of the export formats. Defaults to an array of CsvExporter, DocExporter, HtmlExporter and TxtExporter.
Default: http://www.flexicious.com/Home/Echo
exportFileName
String
File name for the download. Defaults to download.xxx where xxx is the extension.
Default: download
exportOptionsRenderer
ClassFactory
The view responsible for rendering the export options Default implementation is provided by com.flexicious.export.ExportOptionsView
exportOptionsView
UIComponent
An instance of the exportOptionsRenderer. Please note, this is only instantiated when you call the export method on the controller.
Default: null
grid
IExtendedDataGrid
The grid being exported
Default: null
modalWindows
Boolean
Flag, which defaults to false, launches the preview and options screen in modal mode.
Default: null
openNewWindow
Boolean
A property that will launch the resultant export into a new window. Used for the print option.
Default: false
printExportParameters
Object
Any custom data that is passed into the print/export mechanism.
This will then be available on Print/Export Options when the Print or Export is run.
Please note, this is not persisted in preferences.
Default: null
tableWidth
Number
For HTML/DOC export, we specify this so that the nested export does not look jagged
Default: 0
useExcelExporter
Boolean
Instead of using the built in csv exporter, instead exports HTML that Microsoft Excel is able to render. Generates a file with an XLS extension.
Default: false
useSaveFileMessage
Boolean
Flag to control the download message. Defaults to true.
Default: false