Packagecom.flexicious.grids.events
Classpublic class PrintExportOptions
InheritancePrintExportOptions Inheritance Object
Subclasses ExportOptions, PrintOptions

Stores user selection for records to print or to export. Only applicable when the filterPageSortMode of the grid is set to server, and the user requests to print all pages or specific pages of data that are not currently loaded.


Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined By
  
PrintExportOptions()
PrintExportOptions
Public Constants
 ConstantDefined 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
Property Detail
excludeHiddenColumnsproperty
public var excludeHiddenColumns:Boolean = false

A 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.

hideHiddenColumnsproperty 
public var hideHiddenColumns:Boolean = false

A 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.

pageFromproperty 
public var pageFrom:Number = -1

In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES determines which pages of a grid with paging enabled to print.

pageToproperty 
public var pageTo:Number = -1

In conjunction with printOption/exportOption = PRINT_EXORT_SPECIFIED_PAGES determines which pages of a grid with paging enabled to print.

popupParentproperty 
public var 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.

printExportOptionproperty 
public var 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.

saveFileMessageproperty 
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.

showColumnPickerproperty 
public var showColumnPicker:Boolean = true

Flag to control whether or not to show the column picker. Defaults to true.

showWarningMessageproperty 
public var showWarningMessage:Boolean = true

Flag to control whether or not to show the warning message when user changes print layout or page size.

Constructor Detail
PrintExportOptions()Constructor
public function PrintExportOptions()



Constant Detail
PRINT_EXPORT_ALL_PAGESConstant
public static const PRINT_EXPORT_ALL_PAGES:String = All Pages

PRINT_EXPORT_CURRENT_PAGEConstant 
public static const PRINT_EXPORT_CURRENT_PAGE:String = Current Page

PRINT_EXPORT_SELECTED_PAGESConstant 
public static const PRINT_EXPORT_SELECTED_PAGES:String = Selected Pages

PRINT_EXPORT_SELECTED_RECORDSConstant 
public static const PRINT_EXPORT_SELECTED_RECORDS:String = Selected Records




Copyright 2012 Flexicious LLC. All rights reserved.

Mon Jun 24 2013, 11:00 PM -04:00