PRINT reportname ARRANGE clause WHERE clause .. ORDER BY clause .. OPTION XHTML
Note: Each additional OPTION parameter must be separated by the pipe | symbol.
OPTION Parameters:
FILENAME specifies the full path and filename. If no path is defined, output will be saved in the current working directory.
SHOW_CANCEL_DIALOG specifies whether to suppress cancel dialog box during the print process.
Values:
BACKGROUND_FILE stores the image file name that is to be used as background image of all pages of report.
BACKGROUND_TYPE specifies the way background image has to be displayed in the XHTML file.
Values:
BACKGROUND_COLOR indicates the color to be used as background color of all pages of report.
Values:
INCLUDE_LINES specifies whether lines on the report should be included in the exported file.
Values:
INCLUDE_SHAPES specifies whether shapes on the report should be included in the exported file.
Values:
INCLUDE_RICHTEXT specifies whether contents of the RichText objects on the report should be included in the exported file.
Values:
RICHTEXT_ENCODING_TYPE specifies the way in which RichText contents should be encoded in exported HTML document when INCLUDE_RICHTEXT option is set to ON.
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.
Values:
INCLUDE_IMAGES specifies whether Images on the report should be included in the exported file.
Values:
IMAGE_FORMAT specifies the Linked image file format for image controls used in the report when INCLUDE_IMAGES option is set to ON.
Values:
JPEG_QUALITY specifies the quality of the JPEG Image when INCLUDE_IMAGES is set to ON and IMAGE_FORMAT is set to JPG.
Values:
IMAGE_DPI specifies the depth of image as dots per inch.
Values:
PIXELFORMAT specifies the pixel format of the image-file (bits/pixel).
Values:
INCLUDE_HYPERLINKS specifies whether hyperlinks in your report should be included in the exported file.
Values:
TITLE specifies the title of the report.
SUBJECT specifies the subject of the report.
AUTHOR specifies the author of the report.
KEYWORDS 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.
PAGE_END_LINES indicates whether a line should be drawn at the end of each page. Setting PAGE_END_LINES to ON draws a line after each page. PAGE_END_LINES is considered only when SEP_FILE_PER_PAGE is set to OFF.
Values:
OUTPUT_STYLES_TO_CSS_FILE specifies whether to output styles to a CSS (Cascade Style Sheet) file.
Values:
CSSFILE specify the CSS file name if OUTPUT_STYLES_TO_CSS_FILE is set to ON.
OUTPUT_SCRIPTS_TO_JAVA_SCRIPT_FILE specifies whether to output scripts to a Java Script File.
Values:
JAVA_SCRIPT_FILE_NAME specify the file name if the OUTPUT_SCRIPTS_TO_JAVA_SCRIPT_FILE is set to ON.
GENERATE_TOC specifies whether to generate a Table of Contents based on all report Break Header(s), if defined.
Values:
TOC_FILE_NAME specify the file name for the Table of Contents, if the GENERATE_TOC option is set to ON.
IMAGE_FOLDER specify the folder path and name for XHTML document images.
DEFAULT_FONT_NAME specify the default font name for XHTML document.
DEFAULT_FONT_SIZE specify the default font size for XHTML document.
DEFAULT_FONT_COLOR specify the default font color for XHTML document.
DEFAULT_FONT_BOLD specifies whether the font is bold faced.
Values:
DEFAULT_FONT_ITALIC specifies whether the font is italicized.
Values:
DEFAULT_FONT_UNDERLINE specifies whether the font is underlined.
Values:
DEFAULT_FONT_STRIKEOUT specifies whether the font is displayed with a horizontal line through it.
Values:
SEP_FILE_PER_PAGE specifies whether to create a separate file for each page of the report.
Values:
NAV_SHOW Set to ON to show a collection of links that enable easy navigation between pages of the exported XHTML. The links function much like the navigator buttons in the standard preview of Report Preview: one link to jump to the first page; one to the last page; one to the next page and another to get back to the previous page. NAV_SHOW is only effective when the option for SEP_FILE_PER_PAGE is set to ON.
Values:
LINK_BACK_COLOR specifies the background color of navigator. This option will only be used if the SEP_FILE_PER_PAGE and NAV_SHOW options are set to ON.
LINK_H_BACK_COLOR specifies the background color of navigator when the mouse is hovered over it. This option will only be used if the SEP_FILE_PER_PAGE and NAV_SHOW options are set to ON.
LINK_H_FORE_COLOR specifies the color of navigator when the mouse is hovered over it. This option will only be used if the SEP_FILE_PER_PAGE and NAV_SHOW options are set to ON.
USE_TEXT_LINKS specifies the type of the navigator links that should be encoded for a multi-file HTML output. Setting USE_TEXT_LINKS to ON uses the text provided in LINK_TEXT_FIRST, LINK_TEXT_PREV, LINK_TEXT_NEXT and LINK_TEXT_LAST as the hyperlink's caption. Setting to OFF uses Images specified by LINK_IMG_FILE_FIRST, LINK_IMG_FILE_PREV, LINK_IMG_FILE_NEXT, LINK_IMG_FILE_LAST. The property is effective only when the options for SEP_FILE_PER_PAGE and NAV_SHOW are set to ON.
Values:
LINK_TEXT_FIRST specifies the hyperlink's text caption for first page when USE_TEXT_LINKS option is set to ON.
LINK_TEXT_PREV specifies the hyperlink's text caption for previous page when USE_TEXT_LINKS option is set to ON.
LINK_TEXT_NEXT specifies the hyperlink's text caption for next page when USE_TEXT_LINKS option is set to ON.
LINK_TEXT_LAST specifies the hyperlink's text caption for last page when USE_TEXT_LINKS option is set to ON.
LINK_FONT_NAME specify the font name for navigator links.
LINK_FONT_SIZE specify the font size for navigator links.
LINK_FONT_COLOR specify the font color for navigator links.
LINK_FONT_BOLD specifies whether the font is bold faced for navigator links.
Values:
LINK_FONT_ITALIC specifies whether the font is italicized for navigator links.
Values:
LINK_FONT_UNDERLINE specifies whether the font is underlined for navigator links.
Values:
LINK_FONT_STRIKEOUT specifies whether the font for navigator link is displayed with a horizontal line through it.
Values:
LINK_IMG_FILE_FIRST specifies the hyperlink's image file for first page when USE_TEXT_LINKS option is set to OFF.
LINK_IMG_FILE_PREV specifies the hyperlink's image file for previous page when USE_TEXT_LINKS option is set to OFF.
LINK_IMG_FILE_NEXT specifies the hyperlink's image file for next page when USE_TEXT_LINKS option is set to OFF.
LINK_IMG_FILE_LAST specifies the hyperlink's image file for last page when USE_TEXT_LINKS option is set to OFF.
NAV_TYPE specifies the type of the navigator. If NAV_TYPE is set to SCREEN then the navigator will be fixed to screen, else the navigator will be fixed to page. The property is effective only when the options for SEP_FILE_PER_PAGE and NAV_SHOW are set to ON.
Values:
NAV_ORIENT specifies the orientation of the navigator. if NAV_ORIENT is set to HORIZONTAL then, a Horizontal navigator is encoded, else a Vertical navigator is encoded. The property is effective only when the options for SEP_FILE_PER_PAGE and NAV_SHOW are set to ON.
Values:
NAV_POS specifies the position of the navigator. The property is effective only when the options for SEP_FILE_PER_PAGE and NAV_SHOW are set to ON.
Values:
DISABLE_RIGHT_CLICK specifies whether to disable the typical speed menu options when you right click on your mouse button.
Values:
DISABLE_COPYING specifies whether to disable the option to highlight and copy the text.
Values:
AUTO_MAXIMIZE_WINDOW specifies whether to automatically maximize the window when HTML document is opened.
Values:
OPEN specifies whether the report should be opened after it is generated.
Values:
EMAIL specifies the report output (defined as FILENAME filename.ext ) to be sent via e-mail as an attachment.
Values:
See additional options when EMAIL value is set to ON. EMAIL SET ON
Example:
Example 01 (To print SalesSumAndSubTot report as XHTML file)
PRINT SalesSumAndSubTot +
OPTION XHTML +
|FILENAME SalesSumAndSubTot.htm +
|SHOW_CANCEL_DIALOG ON +
|BACKGROUND_FILE NONE +
|BACKGROUND_TYPE CENTER +
|BACKGROUND_COLOR WHITE +
|INCLUDE_LINES ON +
|INCLUDE_SHAPES ON +
|INCLUDE_RICHTEXT OFF +
|RICHTEXT_ENCODING_TYPE PLAINTEXT +
|INCLUDE_IMAGES ON +
|IMAGE_FORMAT JPG +
|JPEG_QUALITY 100 +
|IMAGE_DPI -1 +
|PIXELFORMAT 24 +
|INCLUDE_HYPERLINKS ON +
|TITLE Customer Sales Sub-Totals and Totals +
|SUBJECT ConComp Sales Summary Report +
|AUTHOR Accounting Team of ConComp +
|KEYWORDS SubTotals Totals Sales Summary +
|PAGE_END_LINES ON +
|OUTPUT_STYLES_TO_CSS_FILE ON +
|CSSFILE +
|OUTPUT_SCRIPTS_TO_JAVA_SCRIPT_FILE ON +
|JAVA_SCRIPT_FILE_NAME +
|GENERATE_TOC ON +
|TOC_FILE_NAME Index.htm +
|IMAGE_FOLDER Images +
|DEFAULT_FONT_NAME Verdana +
|DEFAULT_FONT_SIZE 9 +
|DEFAULT_FONT_COLOR BLACK +
|DEFAULT_FONT_BOLD OFF +
|DEFAULT_FONT_ITALIC OFF +
|DEFAULT_FONT_UNDERLINE OFF +
|DEFAULT_FONT_STRIKEOUT OFF +
|SEP_FILE_PER_PAGE ON +
|NAV_SHOW ON +
|LINK_BACK_COLOR WHITE +
|LINK_H_BACK_COLOR BLUE +
|LINK_H_FORE_COLOR WHITE +
|USE_TEXT_LINKS OFF +
|LINK_TEXT_FIRST First +
|LINK_TEXT_PREV Previous +
|LINK_TEXT_NEXT Next +
|LINK_TEXT_LAST Last +
|LINK_FONT_NAME Wingdings +
|LINK_FONT_SIZE 10 +
|LINK_FONT_COLOR BLUE +
|LINK_FONT_BOLD OFF +
|LINK_FONT_ITALIC OFF +
|LINK_FONT_UNDERLINE OFF +
|LINK_FONT_STRIKEOUT OFF +
|LINK_IMG_FILE_FIRST Images\FirstOff.gif +
|LINK_IMG_FILE_PREV Images\PrevOff.gif +
|LINK_IMG_FILE_NEXT Images\NextOff.gif +
|LINK_IMG_FILE_LAST Images\LastOff.gif +
|NAV_TYPE PAGE +
|NAV_ORIENT HORIZONTAL +
|NAV_POS BOTTOMCENTER +
|DISABLE_RIGHT_CLICK OFF +
|DISABLE_COPYING OFF +
|AUTO_MAXIMIZE_WINDOW ON +
|OPEN ON
RETURN
For more examples and templates, please refer to R:Docs (version 2.5 or higher).
