The XHTML output option displays the report in a extensible hypertext markup language file.
Syntax:
PRINT reportname ARRANGE clause WHERE clause .. ORDER BY clause .. OPTION XHTML
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. |
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. |
RICHTEXT_ENCODING_TYPE |
IMAGE PLAINTEXT |
Specifies the way in which Rich Text contents should be encoded in exported HTML document when INCLUDE_RICHTEXT option is set to ON. Set RICHTEXT_ENCODING_TYPE to IMAGE to encode Rich Text contents as exact graphical representations. Set RICHTEXT_ENCODING_TYPE to PLAINTEXT to encode Rich Text contents as unformatted text. The font used when encoding Rich Text as plain text is the one set in the Font property of the Rich Text object. |
INCLUDE_HYPERLINKS |
ON OFF |
Specifies whether hyperlinks in your 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). |
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. |
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.
Detailed HTML parameter options:
PAGE_END_LINES |
ON OFF |
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. |
OUTPUT_STYLES_TO_CSS_FILE |
ON OFF |
Specifies whether to output styles to a CSS (Cascade Style Sheet) file. |
CSSFILE |
value |
Specifies the CSS file name if OUTPUT_STYLES_TO_CSS_FILE is set to ON. |
OUTPUT_SCRIPTS_TO_JAVA_SCRIPT_FILE |
ON OFF |
Specifies whether to output scripts to a Java Script File.
|
JAVA_SCRIPT_FILE_NAME |
value |
Specifies the file name if the OUTPUT_SCRIPTS_TO_JAVA_SCRIPT_FILE is set to ON. |
GENERATE_TOC |
ON OFF |
Specifies whether to generate a Table of Contents based on all report Break Header(s), if defined. |
TOC_FILE_NAME |
value |
Specifies the file name for the Table of Contents, if the GENERATE_TOC option is set to ON. |
IMAGE_FOLDER |
value |
specify the folder path and name for XHTML document images. |
DEFAULT_FONT_NAME |
value |
Specifies the default font name for XHTML document. |
DEFAULT_FONT_SIZE |
value |
Specifies the default font size for XHTML document. |
DEFAULT_FONT_COLOR |
value |
Specifies the default font color for XHTML document. |
DEFAULT_FONT_BOLD |
ON OFF |
Specifies whether the font is bold faced |
DEFAULT_FONT_ITALIC |
ON OFF |
Specifies whether the font is italicized. |
DEFAULT_FONT_UNDERLINE |
ON OFF |
Specifies whether the font is underlined. |
DEFAULT_FONT_STRIKEOUT |
ON OFF |
Specifies whether the font is displayed with a horizontal line through it. |
SEP_FILE_PER_PAGE |
ON OFF |
Specifies whether to create a separate file for each page of the report. |
NAV_SHOW |
ON OFF |
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. |
LINK_BACK_COLOR |
value |
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 |
value |
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 |
value |
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 |
ON OFF |
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. |
LINK_TEXT_FIRST |
value |
Specifies the hyperlink's text caption for first page when USE_TEXT_LINKS option is set to ON. |
LINK_TEXT_PREV |
value |
Specifies the hyperlink's text caption for previous page when USE_TEXT_LINKS option is set to ON. |
LINK_TEXT_NEXT |
value |
Specifies the hyperlink's text caption for next page when USE_TEXT_LINKS option is set to ON. |
LINK_TEXT_LAST |
value |
Specifies the hyperlink's text caption for last page when USE_TEXT_LINKS option is set to ON. |
LINK_FONT_NAME |
value |
Specifies the font name for navigator links. |
LINK_FONT_SIZE |
value |
Specifies the font size for navigator links. |
LINK_FONT_COLOR |
value |
Specifies the font color for navigator links. |
LINK_FONT_BOLD |
ON OFF |
Specifies whether the font is bold faced for navigator links. |
LINK_FONT_ITALIC |
ON OFF |
Specifies whether the font is italicized for navigator links. |
LINK_FONT_UNDERLINE |
ON OFF |
Specifies whether the font is underlined for navigator links. |
LINK_FONT_STRIKEOUT |
ON OFF |
Specifies whether the font for navigator link is displayed with a horizontal line through it. |
LINK_IMG_FILE_FIRST |
value |
Specifies the hyperlink's image file for first page when USE_TEXT_LINKS option is set to OFF. |
LINK_IMG_FILE_PREV |
value |
Specifies the hyperlink's image file for previous page when USE_TEXT_LINKS option is set to OFF. |
LINK_IMG_FILE_NEXT |
value |
Specifies the hyperlink's image file for next page when USE_TEXT_LINKS option is set to OFF. |
LINK_IMG_FILE_LAST |
value |
Specifies the hyperlink's image file for last page when USE_TEXT_LINKS option is set to OFF. |
NAV_TYPE |
PAGE SCREEN |
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. |
NAV_ORIENT |
VERTICAL HORIZONTAL |
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. |
NAV_POS |
TOPLEFT TOPCENTER TOPRIGHT CENTERLEFT CENTER CENTERRIGHT BOTTOMLEFT BOTTOMCENTER BOTTOMRIGHT |
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. |
DISABLE_RIGHT_CLICK |
ON OFF |
Specifies whether to disable the typical speed menu options when you right click on your mouse button. |
DISABLE_COPYING |
ON OFF |
Specifies whether to disable the option to highlight and copy the text. |
AUTO_MAXIMIZE_WINDOW |
ON OFF |
Specifies whether to automatically maximize the window when HTML document is opened. |
Note: Each additional OPTION parameter must be separated by the pipe | symbol.
Example:
--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
