GetExportFilter

<< Click to Display Table of Contents >>

 

GetExportFilter

GetExportFilter(FilterName)

Returns an object specifying custom export parameters for a Report. This method contains a FilterName parameter, which indicate a type of format for exporting. The available options for the FilterName parameter are the following:

PDF: Exports data to PDF (Portable Document Format) format

Excel: Exports data to Excel's spreadsheet format

HTML: Exports data to HTML (Hyper Text Markup Language) format

TEXT: Exports data to Text format

RTF: Exports data to RTF (Rich Text Format) format

TIFF: Exports data to TIFF (Tag Image File Format) format

 

After retrieving a filter, all properties described on the next table can be modified.

Available properties on an export filter

Property

Filter

Description

AutoRowHeight

Excel

In True (default), automatically configures a row's height. In False,configures size to the largest element on a row

BorderSpace

Excel

Minimum space between cells. Default value is 59 twips

CreateCSSFile

HTML

If True, generates a CSS file on the directory indicated by HTMLOutputPath

DoubleBoundaries

Excel

In True, indicates that elements aligned to the right must replace the ones aligned to the left on the same column. Otherwise, leave it in False to free more space

ExportRange

HTML

Indicates a range of pages for exporting, such as "1, 2, 3-9, 14"

FaxExport

TIFF

Object that allows exporting data in RFC 1314 TIFF format

FileName

All

Informs the name of a file to which data is exported

GenPageBreaks

HTML

In True, places page breaks under the lowest element in each Report's page

HTMLOutputPath

HTML

Default path for HTML files

JPGQuality

PDF

Indicates the quality level of exported images, between 0 (zero) and 100

MinColumnWidth

Excel

Minimum size of a column. Default value is 1011 twips

MinRowHeight

Excel

Minimum size of a row

MultiSheet

Excel

In True, each Report page goes to a separate spreadsheet

PageDelimiter

Text

Configures or returns a delimiter character between pages

SuppressEmptyLines

Text

Removes or inserts empty lines, for layout purposes

TextDelimiter

HTML

Configures or returns a delimiter character between texts

TrimEmptySpace

Excel

In True, the vertical space between elements is removed. Default is False

Unicode

Text

Determines whether text is saved in Unicode format (16 bits) or not

WebCacheOutput

HTML

In True, a Report is exported to the WebCache service. Otherwise (default), it is not exported

Was this page useful?