The RTF output option displays the report in a rich text format file.
Syntax:
PRINT reportname ARRANGE clause WHERE clause .. ORDER BY clause .. OPTION RTF
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. |
APPEND |
Appends the report data to the specified FILENAME value. |
|
SHOW_CANCEL_DIALOG |
ON (default) OFF |
Specifies whether to suppress cancel dialog box during the print process. |
BACKGROUND_COLOR |
value |
Indicates the color to be used as background color of all pages of report. |
BACKGROUND_TYPE |
TILE TOPLEFT TOPCENTER TOPRIGHT CENTERLEFT CENTER CENTERRIGHT BOTTOMLEFT BOTTOMCENTER BOTTOMRIGHT |
Specifies the way background image has to be displayed in the file. |
BACKGROUND_FILE |
value |
Stores the image file name that is to be used as background image of all pages of report. |
INCLUDE_LINES |
ON OFF |
Specifies whether lines on the report should be included in the exported file. |
INCLUDE_SHAPES |
ON OFF |
Specifies whether shapes on the report should be included in the exported file. |
INCLUDE_RICHTEXT |
ON OFF |
Specifies whether contents of the Rich Text objects on the report should be included in the exported file. |
INCLUDE_IMAGES |
ON OFF |
Specifies whether images on the report should be included in the exported file. |
IMAGE_FORMAT |
GIF JPG BMP |
Specifies the linked image file format for image controls used in the report when INCLUDE_IMAGES option is set to ON. |
JPEG_QUALITY |
value 0 - 100 |
Specifies the quality of the JPEG image when INCLUDE_IMAGES is set to ON and IMAGE_FORMAT is set to JPG. |
IMAGE_DPI |
value |
Specifies the depth of image as "dots per inch" to enhance the image. By increasing this value, the file size will increase. An example would be 200. The Default Value is -1. |
PIXELFORMAT |
1 : 1bit 4 : 4bit 8 : 8bit 15 : 15bit 16 : 16bit 24 : 24bit 32 : 32bit |
Specifies the pixel format of the image file (bits/pixel). |
GRAPHIC_DATA_IN_BINARY |
ON (default) OFF |
Specifies whether graphic data is to be encoded in binary format. Set to ON to encode graphic data in binary format. If OFF, graphic data is encoded in hexadecimal format. |
OPTIMIZATION |
POSITIONAL_ACCURACY (default) EASE_OF_EDITING |
Specifies the type of encoding of the RTF document. Resulting RTF document can be either optimized for positional accuracy (meaning that the placement of the objects will be as close as possible to a printed report), or for ease of editing (meaning that everything is treated as simple text and it is much easier to edit the file at the expense of aesthetics). Set OPTIMIZATION EASE_OF_EDITING if you wish to easily modify the resulting RTF document. |
TITLE |
value |
Specifies the title of the report |
SUBJECT |
value |
Specifies the subject of the report |
AUTHOR |
value |
Specifies the author of the report |
KEYWORDS |
value |
Stores the list of keywords used in the report. Specify a list of keywords for the document that should be encoded as the Keywords Meta content in RTF document property summary. |
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 |
Note: Each additional OPTION parameter must be separated by the pipe | symbol.
Example:
--To print invoice report as RTF document
PRINT Invoice WHERE TransID = 1068 +
OPTION RTF +
|FILENAME Invoice1068.RTF +
|SHOW_CANCEL_DIALOG ON +
|BACKGROUND_FILE NONE +
|BACKGROUND_TYPE CENTER +
|INCLUDE_LINES ON +
|INCLUDE_SHAPES ON +
|INCLUDE_RICHTEXT ON +
|INCLUDE_IMAGES ON +
|IMAGE_FORMAT JPG +
|JPEG_QUALITY 100 +
|IMAGE_DPI -1 +
|PIXELFORMAT 32 +
|GRAPHIC_DATA_IN_BINARY ON +
|OPTIMIZATION POSITIONAL_ACCURACY +
|TITLE Customer Invoice +
|SUBJECT Sales Order +
|AUTHOR Accounting Team of Consolidated Computer Company +
|KEYWORDS Invoice +
|OPEN ON
