Home Reference Source
public class | source

PrintExportOptions

Extends:

TypedObject → PrintExportOptions

Direct Subclass:

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.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

A flag that will To disable the user from printing or exporting invisible columns altogether .

public

A flag that will hide any columns that are not visible from being printed or exported by default.

public

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
public

Specifies what to export, valid options are: EXPORT_CURRENT_PAGE EXPORT_ALL_PAGES EXPORT_SPECIFIED_PAGES EXPORT_SELECTED_RECORDS

public

Not used.

public

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

public

Method Summary

Public Methods
public

Inherited Summary

From class TypedObject
public

typeCache: {}

public
public

Returns a list of strings that represent the object hierarchy for this object.

public

Returns true if the class name to check is in the list of class names defined for this class.

Public Constructors

public constructor() source

Override:

TypedObject#constructor

Public Members

public excludeHiddenColumns: boolean source

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

Properties:

NameTypeAttributeDescription
excludeHiddenColumns *

public hideHiddenColumns: boolean source

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.

Properties:

NameTypeAttributeDescription
hideHiddenColumns *

public pageFrom: * source

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

Properties:

NameTypeAttributeDescription
pageFrom *

public pageTo: * source

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

Properties:

NameTypeAttributeDescription
pageTo *

public popupParent: * source

public printExportOption: * source

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.

Properties:

NameTypeAttributeDescription
printExportOption *

public saveFileMessage: string source

Not used.

public showColumnPicker: boolean source

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

Properties:

NameTypeAttributeDescription
showColumnPicker *

public showWarningMessage: boolean source

Public Methods

public getClassNames(): string[] source

Returns a list of strings that represent the object hierarchy for this object.

Override:

TypedObject#getClassNames

Return:

string[]