import ExportOptions from 'flexicious-react-datagrid/js/flexgrid/export/ExportOptions.js'

public class | source

ExportOptions

Extends:

TypedObject → PrintExportOptions → ExportOptions

Class to export the datagrid, either one page at a time or specific pages, or all pages.

Static Method Summary

Static Public Methods
public static	create(exporterIndex: *): ExportOptions Convenience method to create an exporter of a specified type

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	availableColumns: * A list of exportable columns
public	columnsToExport: * A list of columns to export
public	copyToClipboard: * Flag to copy the buffer to clipboard, instead of sending it to the server/disk.
public	echoUrl: String A URL that the export infrastructure uses to trigger a file download.
public	enableLocalFilePersistence: * Flag to enable local file persistence.
public	exportAllRecords: * If set to true, exports all the records, irrespective of the filter and paging functions.
public	exportFileName: * File name for the download.
public	exportOptionsRenderer: * The view responsible for rendering the export options Default implementation is provided by com.flexicious.export.ExportOptionsView
public	exportOptionsView: * An instance of the exportOptionsRenderer.
public	exportOptionsWindowTitle: * Title for the print options dialog
public	exporter: flexiciousNmsp.CsvExporter
public	exporters: * A list of exporters that are responsible for handling each of the export formats.
public	grid: * The grid being exported
public	includeFooters: boolean Whether or not to include footer cells in the export
public	modalWindows: * Flag, which defaults to false, launches the preview and options screen in modal mode.
public	openNewWindow: * A property that will launch the resultant export into a new window.
public	printExportParameters: * Any custom data that is passed into the print/export mechanism.
public	tableWidth: * For HTML/DOC export, we specify this so that the nested export does not look jagged
public	useExcelExporter: * Instead of using the built in csv exporter, instead exports HTML that Microsoft Excel is able to render.
public	useSaveFileMessage: * Flag to control the download message.

Method Summary

Public Methods
public	getClassNames(): string[]
public	getExporterName(): * Name of the current exporter.

Inherited Summary

From class TypedObject
public	typeCache: {}
public	constructed()
public	getClassNames(): Array Returns a list of strings that represent the object hierarchy for this object.
public	implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class.

From class PrintExportOptions
public	excludeHiddenColumns: boolean A flag that will To disable the user from printing or exporting invisible columns altogether .
public	hideHiddenColumns: boolean A flag that will hide any columns that are not visible from being printed or exported by default.
public	pageFrom: * In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES determines which pages of a grid with paging enabled to print.
public	pageTo: * In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES determines which pages of a grid with paging enabled to print.
public	popupParent: *
public	printExportOption: * Specifies what to export, valid options are: EXPORT_CURRENT_PAGE EXPORT_ALL_PAGES EXPORT_SPECIFIED_PAGES EXPORT_SELECTED_RECORDS
public	saveFileMessage: string Not used.
public	showColumnPicker: boolean Flag to control whether or not to show the column picker.
public	showWarningMessage: boolean
public	getClassNames(): string[]

Static Public Methods

public static create(exporterIndex: *): ExportOptions source

Convenience method to create an exporter of a specified type

Params:

Name	Type	Attribute	Description
exporterIndex	*

Return:

ExportOptions

Public Constructors

public constructor() source

Override:

PrintExportOptions#constructor

Public Members

public availableColumns: * source

A list of exportable columns

Properties:

Name	Type	Attribute	Description
availableColumns	*

public columnsToExport: * source

A list of columns to export

Properties:

Name	Type	Attribute	Description
columnsToExport	*

public copyToClipboard: * source

Flag to copy the buffer to clipboard, instead of sending it to the server/disk.

Properties:

Name	Type	Attribute	Description
copyToClipboard	*

public echoUrl: String source

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: It is recommended you provide your own echo URL.

Properties:

Name	Type	Attribute	Description
echoUrl	*

public enableLocalFilePersistence: * source

Flag to enable local file persistence. Defaults to true for Flex 4.

Properties:

Name	Type	Attribute	Description
enableLocalFilePersistence	*

public exportAllRecords: * source

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

Properties:

Name	Type	Attribute	Description
exportAllRecords	*

public exportFileName: * source

File name for the download. Defaults to download.xxx where xxx is the extension.

Properties:

Name	Type	Attribute	Description
exportFileName	*

public exportOptionsRenderer: * source

The view responsible for rendering the export options Default implementation is provided by com.flexicious.export.ExportOptionsView

Properties:

Name	Type	Attribute	Description
exportOptionsRenderer	*

public exportOptionsView: * source

An instance of the exportOptionsRenderer. Please note, this is only instantiated when you call the export method on the controller.

Properties:

Name	Type	Attribute	Description
exportOptionsView	*

public exportOptionsWindowTitle: * source

Title for the print options dialog

Properties:

Name	Type	Attribute	Description
printOptionsWindowTitle	*

public exporter: flexiciousNmsp.CsvExporter source

Properties:

Name	Type	Attribute	Description
exporter	*

public exporters: * source

A list of exporters that are responsible for handling each of the export formats. Defaults to an array of CsvExporter, DocExporter, HtmlExporter and TxtExporter.

Properties:

Name	Type	Attribute	Description
exporters	*

public grid: * source

The grid being exported

Properties:

Name	Type	Attribute	Description
grid	*

public includeFooters: boolean source

Whether or not to include footer cells in the export

public modalWindows: * source

Flag, which defaults to false, launches the preview and options screen in modal mode.

Properties:

Name	Type	Attribute	Description
modalWindows	*

public openNewWindow: * source

A property that will launch the resultant export into a new window. Used for the print option.

Properties:

Name	Type	Attribute	Description
openNewWindow	*

public printExportParameters: * source

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.

Properties:

Name	Type	Attribute	Description
printExportParameters	*

public tableWidth: * source

For HTML/DOC export, we specify this so that the nested export does not look jagged

Properties:

Name	Type	Attribute	Description
tableWidth	*

public useExcelExporter: * source

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.

Properties:

Name	Type	Attribute	Description
useExcelExporter	*

public useSaveFileMessage: * source

Flag to control the download message. Defaults to true.

Properties:

Name	Type	Attribute	Description
useSaveFileMessage	*

ExportOptions

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static create(exporterIndex: *): ExportOptions source

Params:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public availableColumns: * source

Properties:

public columnsToExport: * source

Properties:

public copyToClipboard: * source

Properties:

public echoUrl: String source

Properties:

public enableLocalFilePersistence: * source

Properties:

public exportAllRecords: * source

Properties:

public exportFileName: * source

Properties:

public exportOptionsRenderer: * source

Properties:

public exportOptionsView: * source

Properties:

public exportOptionsWindowTitle: * source

Properties:

public exporter: flexiciousNmsp.CsvExporter source

Properties:

public exporters: * source

Properties:

public grid: * source

Properties:

public includeFooters: boolean source

public modalWindows: * source

Properties:

public openNewWindow: * source

Properties:

public printExportParameters: * source

Properties:

public tableWidth: * source

Properties:

public useExcelExporter: * source

Properties:

public useSaveFileMessage: * source

Properties:

Public Methods

public getClassNames(): string[] source

Override:

Return:

public getExporterName(): * source

Return: