| Package | com.flexicious.grids.events |
| Class | public class PrintExportOptions |
| Inheritance | PrintExportOptions  Object |
| Subclasses | ExportOptions, PrintOptions |
| Property | Defined By | ||
|---|---|---|---|
| excludeHiddenColumns : Boolean = false
A flag that will To disable the user from printing or exporting invisible columns altogether . | PrintExportOptions | ||
| hideHiddenColumns : Boolean = false
A flag that will hide any columns that are not visible from being printed or exported by default. | PrintExportOptions | ||
| pageFrom : Number = -1
In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES
determines which pages of a grid with paging enabled
to print. | PrintExportOptions | ||
| pageTo : Number = -1
In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES
determines which pages of a grid with paging enabled
to print. | PrintExportOptions | ||
| popupParent : DisplayObject
In scenarios where you are using modules, or are in an AIR application,
where you want the window to open up as a child of anything other than
the top level application, use this property. | PrintExportOptions | ||
| printExportOption : String = Current Page
Specifies what to export, valid options are:
EXPORT_CURRENT_PAGE
EXPORT_ALL_PAGES
EXPORT_SPECIFIED_PAGES
EXPORT_SELECTED_RECORDS
The All pages and specified pages are only available
if paging is enabled and the grid is in client mode. | PrintExportOptions | ||
| saveFileMessage : String = File generated. Download?
To bypass flash player 10 security when filterPageSortMode="server", we need
user action to initiate file download. | PrintExportOptions | ||
| showColumnPicker : Boolean = true
Flag to control whether or not to show the column picker. | PrintExportOptions | ||
| showWarningMessage : Boolean = true
Flag to control whether or not to show the warning message when user changes print layout or page size. | PrintExportOptions | ||
| Method | Defined By | ||
|---|---|---|---|
| PrintExportOptions | |||
| Constant | Defined By | ||
|---|---|---|---|
| PRINT_EXPORT_ALL_PAGES : String = All Pages [static] | PrintExportOptions | ||
| PRINT_EXPORT_CURRENT_PAGE : String = Current Page [static] | PrintExportOptions | ||
| PRINT_EXPORT_SELECTED_PAGES : String = Selected Pages [static] | PrintExportOptions | ||
| PRINT_EXPORT_SELECTED_RECORDS : String = Selected Records [static] | PrintExportOptions | ||
| excludeHiddenColumns | property |
public var excludeHiddenColumns:Boolean = falseA flag that will To disable the user from printing or exporting invisible columns altogether . User cannot go into column picker and include these columns. To hide any columns that are not visible from being printed or exported by default, please use the hideHiddenColumns instead
The default value is false.
| hideHiddenColumns | property |
public var hideHiddenColumns:Boolean = falseA flag that will hide any columns that are not visible from being printed or exported by default. User can still go into column picker and include these columns. To disable the user from printing or exporting invisible columns altogether, please use the excludeHiddenColumns instead. Please note, when you set this flag, the columnsToPrint will get overwritten, so any changes you make to that array will be ignored.
The default value is false.
| pageFrom | property |
public var pageFrom:Number = -1In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES determines which pages of a grid with paging enabled to print.
| pageTo | property |
public var pageTo:Number = -1In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES determines which pages of a grid with paging enabled to print.
| popupParent | property |
public var popupParent:DisplayObjectIn scenarios where you are using modules, or are in an AIR application, where you want the window to open up as a child of anything other than the top level application, use this property.
| printExportOption | property |
public var printExportOption:String = Current PageSpecifies what to export, valid options are: EXPORT_CURRENT_PAGE EXPORT_ALL_PAGES EXPORT_SPECIFIED_PAGES EXPORT_SELECTED_RECORDS The All pages and specified pages are only available if paging is enabled and the grid is in client mode.
| saveFileMessage | property |
public var saveFileMessage:String = File generated. Download?To bypass flash player 10 security when filterPageSortMode="server", we need user action to initiate file download. This is the message we show the user to initiate user action.
| showColumnPicker | property |
public var showColumnPicker:Boolean = trueFlag to control whether or not to show the column picker. Defaults to true.
| showWarningMessage | property |
public var showWarningMessage:Boolean = trueFlag to control whether or not to show the warning message when user changes print layout or page size.
| PrintExportOptions | () | Constructor |
public function PrintExportOptions()| PRINT_EXPORT_ALL_PAGES | Constant |
public static const PRINT_EXPORT_ALL_PAGES:String = All Pages| PRINT_EXPORT_CURRENT_PAGE | Constant |
public static const PRINT_EXPORT_CURRENT_PAGE:String = Current Page| PRINT_EXPORT_SELECTED_PAGES | Constant |
public static const PRINT_EXPORT_SELECTED_PAGES:String = Selected Pages| PRINT_EXPORT_SELECTED_RECORDS | Constant |
public static const PRINT_EXPORT_SELECTED_RECORDS:String = Selected Records