The XLS output option displays the report in a Microsoft Excel format file.
Syntax:
PRINT reportname ARRANGE clause WHERE clause .. ORDER BY clause .. OPTION XLS
The following OPTION parameters are available to customize the output:
Parameter |
Value |
Description |
FILENAME |
value |
Specifies the full path and file name. If no path is defined, output will be saved in the current working directory. |
PASSWORD |
value |
Specifies the password for the Excel file. Passwords are case sensitive. |
SHOW_CANCEL_DIALOG |
ON (default) OFF |
Specifies whether to suppress cancel dialog box during the print process. |
ALL_TEXT_IN_GENERAL_FORMAT |
ON OFF |
Specifies whether all the text in the report should be converted to general format or the format of the text should be detected and encoded accordingly (Integer, Double etc). |
CELL_ATTR |
ON OFF |
Cell attributes include shading of the cell whose color is not WHITE. |
INCLUDE_IMAGES |
ON OFF |
Specifies whether image objects on the report should be included in the exported file. |
IMAGE_FORMAT |
BMP WMF |
Specifies the image file format for image controls used in the report. |
INCLUDE_LINES |
ON OFF (default) |
Specifies whether lines on the report should be included in the exported file. |
INCLUDE_RICH_TEXT |
ON (default) OFF |
Specifies whether contents of the Rich Text objects on the report should be included in the exported file. |
RICHTEXT_ENCODING_TYPE |
IMAGE (default) PLAINTEXT |
Indicates the way in which Rich Text contents should be encoded in the output.
Set RICHTEXT_ENCODING_TYPE to IMAGE to encode RichText contents as exact graphical representations. Set RICHTEXT_ENCODING_TYPE to PLAINTEXT to encode RichText contents as unformatted text. The font used when encoding RichText as plain text is the one set in the Font property of the RichText object. When RICHTEXT_ENCODING_TYPE is set to PLAINTEXT make sure you set the Default Font property of the RichText control in report designer to true and set the required font in the Font property. |
INCLUDE_SHAPES |
ON OFF (default) |
Specifies whether shapes on the report should be included in the exported file. |
LINE_SPACE |
ACTUAL 0 1 2 3 4 5 |
Specifies the spacing to be used between lines of text. |
ONE_SHEET_PER_PAGE |
ON OFF (default) |
Specifies whether each page in the report should be encoded into separate excel sheets or all the pages should be encoded in a single excel sheet. |
OPEN |
ON OFF |
Specifies whether the report should be opened after it is generated. |
PAGE_SETTINGS |
ALL FIRST LAST PAGE_LIST |
Specifies the option to print All, First, Last or a given number of pages. When PAGE_LIST is set as the value for PAGE_SETTINGS, the PAGE_LIST_VALUES parameter must be used with option in order to specify the page list. |
PAGE_LIST_VALUES |
value |
Specifies the values for number of pages, such as, 3,5,8 or 3,8 or 3, or 1-3,8 or 3,5,9-15. This option must be used with the PAGE_SETTINGS parameter when PAGE_LIST is specified. |
PAGE_STYLE_SETTINGS |
ALL FIRST LAST Page List e.g. 1,4-6,10-12,20 |
Determines the pages in which the Page Style will appear on. |
MARGIN_LEFT |
value |
Specifies the horizontal position on the page where printing should begin. All report component positions are relative to the margin. In other words, if the MARGIN_LEFT parameter is set to 0.25 inches and you place a report component in a band and set the component's "left" parameter to 0, then that component will print 0.25 inches from the edge of page (or at the left margin). |
MARGIN_TOP |
value |
Specifies the vertical position on the page where printing should begin. All report component positions are relative to the margin. In other words, if the MARGIN_TOP parameter is set to 0.25 inches and you place a report component in a band and set the component's "top" parameter to 0, then that component will print 0.25 inches from the edge of page (or at the top margin). |
MARGIN_RIGHT |
value |
Specifies the horizontal position on the page where printing should stop. All report component positions are relative to the margin. |
MARGIN_BOTTOM |
value |
Specifies the vertical position on the page where printing should stop. All report component positions are relative to the margin. |
ON OFF |
Specifies the report output (defined as FILENAME filename.ext ) to be sent via e-mail as an attachment. See additional options when EMAIL value is set to ON. EMAIL SET ON |
Notes:
•Each additional OPTION parameter must be separated by the pipe | symbol.
•When printing to the XLS format, the report objects must be spaced apart appropriately or "padded" in order for the report data to appear correctly in the Excel report output. Experimenting with vertical and horizontal will also allow you to attain your desired output. Also, please refrain from using elaborate fonts that may not be supported within Excel.
Examples:
--To print Invoices as XLS file
PRINT Invoice WHERE CustID = 127 +
OPTION XLS +
|FILENAME Invoice.XLS +
|SHOW_CANCEL_DIALOG OFF +
|ALL_TEXT_IN_GENERAL_FORMAT OFF +
|CELL_ATTR ON +
|INCLUDE_IMAGES OFF +
|INCLUDE_LINES OFF +
|INCLUDE_RICH_TEXT ON +
|RICHTEXT_ENCODING_TYPE IMAGE +
|INCLUDE_SHAPES OFF +
|LINE_SPACE ACTUAL +
|ONE_SHEET_PER_PAGE ON +
|OPEN ON
--To print an encrypted spreadsheet
PRINT BonusRates OPTION XLS +
|FILENAME BonusRate.xls +
|PASSWORD PeachCobbler
