PDF
Top  Previous  Next


PRINT reportname ARRANGE clause WHERE clause .. ORDER BY clause .. OPTION PDF

PRINT_OPTION_PDF


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:
ON (default)  
OFF  

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 PDF file.

Values:
TILE  
TOPLEFT  
TOPCENTER  
TOPRIGHT  
CENTERLEFT  
CENTER  
CENTERRIGHT  
BOTTOMLEFT  
BOTTOMCENTER  
BOTTOMRIGHT  

BACKGROUND_COLOR
indicates the color to be used as background color of all pages of report.

Values:
AQUA  
BLACK  
BLUE  
CREAM  
DARK GRAY  
FUCHSIA  
GRAY  
GREEN  
LIME  
LIGHT GRAY  
MAROON  
MEDIUM GRAY  
MINT GREEN  
NAVY  
OLIVE  
PURPLE  
RED  
SILVER  
SKY BLUE  
TEAL  
WHITE (default)  
YELLOW  

INCLUDE_LINES specifies whether lines on the report should be included in the exported file.

Values:
ON  
OFF  

INCLUDE_SHAPES
specifies whether shapes on the report should be included in the exported file.

Values:
ON  
OFF  

INCLUDE_RICHTEXT
specifies whether contents of the RichText objects on the report should be included in the exported file.

Values:
ON  
OFF  

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:
IMAGE  
PLAINTEXT  

INCLUDE_IMAGES specifies whether Images on the report should be included in the exported file.

Values:
ON  
OFF  

IMAGE_FORMAT specifies the Linked image file format for image controls used in the report when INCLUDE_IMAGES option is set to ON.

Values:
GIF  
JPG  
BMP  

JPEG_QUALITY specifies the quality of the JPEG Image when INCLUDE_IMAGES is set to ON and IMAGE_FORMAT is set to JPG.

Values:
1-100  

IMAGE_DPI specifies the depth of image as dots per inch.

Values:
-1  

PIXELFORMAT
specifies the pixel format of the image-file (bits/pixel).

Values:
1 : 1bit  
4 : 4bit  
8 : 8bit  
15 : 15bit  
16 : 16bit  
24 : 24bit  
32 : 32bit  

INCLUDE_HYPERLINKS
specifies whether to convert all Internet addresses in your report to hyperlinks.

Values:
ON  
OFF  

GENERATE_TOC specifies whether to generate a Table of Contents based on all report Break Header(s), if defined.

Values:
ON  
   OFF  

Set GENERATE_TOC to ON to generate a table of contents based on report headers, if defined, and encode it as outlines in PDF document.

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 in PDF document summary properties.

USE_COMPRESSION
specifies whether compression should be used.

Values:
   ON  
   OFF  

COMPRESSION_METHOD specifies the type of compression to be used to compress text and Image.

Values:
FASTEST  
NORMAL  
MAXCOMPRESS  

FONT_ENCODING specifies the type of font encoding to be used to encode font.

Values:
WIN_ANSI  
MAC_ROMAN  
MAC_EXPERT  
STANDART  
PDF_DOC  

EMBED_USED_FONTS specifies whether all the used fonts should be embedded in the PDF document.

Values:
ON  
OFF  

Set EMBED_USED_FONTS to ON to embed all the fonts used in the report. Fonts are embedded only if embedding is permitted depending on the Embedding Flags of the font.

ENCRYPT_FILE specifies whether the PDF document should be encrypted.

Values:
   ON  
   OFF (default)  

Set ENCRYPT_FILE to ON to encrypt the PDF document.

USER_PASSWORD
specifies the user password of the encrypted PDF document. Opening the document with the correct user password allows additional operations to be performed according to the user access permissions specified by the permissions properties such as, ENABLE_PRINTING (ON/OFF), ENABLE_COPYING (ON/OFF), and ENABLE_MODIFYING (ON/OFF). These permissions are considered by the viewer applications if the document is opened with the User password. If ENABLE_PRINTING is OFF then printing is not enabled. If ENABLE_COPYING is OFF then page contents cannot be selected and copied. If ENABLE_MODIFYING is OFF then the PDF document cannot be modified.

OWNER_PASSWORD specifies the owner password of the encrypted PDF document. Opening the document with the correct owner password (assuming it is not same as the user password) allows full (owner) access to the document. This unlimited access includes the ability to change the document's passwords and access permissions.

ENCRYPTION_LEVEL specifies the level of encryption of the PDF document.

Values:
   40BIT  
   128BIT  
   
Set ENCRYPTION_LEVEL to 40BIT for a 40 bit encryption of the PDF document, i.e a 40 bit key is used to encrypt the PDF document. Set ENCRYPTION_LEVEL to 128BIT for a 128 bit encryption of the PDF document, i.e a 128 bit key is used to encrypt the PDF document. ENCRYPTION_LEVEL is considered only if ENCRYPT_FILE is set to ON.

ENABLE_PRINTING specifies whether to allow printing when USER_PASSWORD is set.

Values:
   ON (default)  
   OFF  

If ENABLE_PRINTING is OFF then the printing is not enabled.

ENABLE_COPYING specifies whether to allow page contents to be selected and copied when USER_PASSWORD is set.

Values:
   ON (default)  
   OFF  

If ENABLE_COPYING is OFF then the page contents cannot be selected and copied.

ENABLE_MODIFYING specifies whether the PDF document can be modified when USER_PASSWORD is set.

Values:
   ON (default)  
   OFF  

If ENABLE_MODIFYING is OFF then the PDF document cannot be modified.
HIDE_TOOLBAR specifies whether to hide the viewer application's toolbars, such as Acrobat Reader or R:PDF Viewer, when the document is active. If the value is ON then the viewer applications toolbars are hidden.

Values:
   ON  
   OFF (default)  

HIDE_MENUBAR specifies whether to hide the viewer application's menu bar, such as Acrobat Reader or R:PDF Viewer, when the document is active. If the value is ON then the viewer applications menu bar is hidden.

Values:
   ON  
   OFF (default)  

HIDE_WINDOW_UI specifes whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. If the value is ON then documents user interface elements are hidden.

Values:
   ON  
   OFF (default)  

FIT_WINDOW specifies whether to resize the document's window to fit the size of the first displayed page. If the value is ON then the first page displayed is resized to fit the document's window.

Values:
   ON  
   OFF (default)  

CENTER_WINDOW secifies whether to position the document's window in the center of the screen. If the value is ON then the document is positioned at the center of the screen when opened.

Values:
   ON  
   OFF (default)  

PAGE_LAYOUT specifies the page layout to be used when the PDF document is opened.

Values:
   SINGLE_PAGE  
   ONE_COLUMN  
   TWO_COLUMN_LEFT  
   TWO_COLUMN_RIGHT  

If the value is set to SINGLE_PAGE then one page is displayed at a time. If the value is set to ONE_COLUMN then pages are displayed in one column. If the value is set to TWO_COLUMN_LEFT then pages are displayed in two columns with odd numbered pages on the left. If the value is set to TWO_COLUMN_RIGHT then pages are displayed in two columns with odd numbered pages on the right.

PAGE_MODE specifies how the document should be displayed when opened.

Values:
   ONE  
   OUTLINES  
   THUMBS  
   FULLSCREEN  

If the value is set to ONE then neither document outlines nor thumbnail images are visible. If the value is set to OUTLINES then document outline is visible. If the value is set to THUMBS then thumbnail images are visible. If the value is setto FULLSCREEN then document is opened in Full Screen mode with no menu bar, window controls, or any other window visible.

NON_FULL_SCREEN_PAGE_MODE specifies how to display the document on exiting full screen mode. This is meaningful only if the PAGE_MODE value is set to FULLSCREEN.

Values:
   NONE  
   USE_OUTLINES  
   USE_THUMB  

If the value is set to NONE then neither document outlines nor thumbnail images are visible. If the value is set to USE_OUTLINES then document outline is visible. If the value is set to USE_TNUMB then thumbnail images are visible.

PRESENTATION_MODE similar to transition effects specifies how the viewer application, such as Acrobat Reader or R:PDF Viewer, should display/present the document. Some viewer applications allow a document to be displayed in the form of a presentation or "slide show," advancing from one page to the next either automatically or under user control.

Values:
   SPLIT_HOR_INWARD  
   SPLIT_HOR_OUTWARD  
   SPLIT_VERT_INWARD  
   SPLIT_VERT_OUTWARD  
   BLINDS_HOR  
   BLINDS_VERT  
   BOX_INWARD  
   BOX_OUTWARD  
   WIPE_LEFT_TO_RIGHT  
   WIPE_BOTTOM_TO_TOP  
   WIPE_RIGHT_TO_LEFT  
   WIPE_TOP_TO_BOTTOM  
   DISSOLVE  
   GLITTER_LEFT_TO_RIGHT  
   GLITTER_TOP_TO_BOTTOM  
   GLITTER_TOPLEFT_TO_BOTTOMRIGHT  
   NONE  

SPLIT_HOR_INWARD: Two lines sweep across the screen, revealing the new page. The lines are horizontal and move inward from the edges of the page.

SPLIT_HOR_OUTWARD: Two lines sweep across the screen, revealing the new page. The lines are horizontal and move outward from the center of the page.

SPLIT_VERT_INWARD: Two lines sweep across the screen, revealing the new page. The lines are vertical and move inward from the edges of the page.

SPLIT_VERT_OUTWARD: Two lines sweep across the screen, revealing the new page. The lines are vertical and move outward from the center of the page.

BLINDS_HOR: Multiple lines, evenly spaced across the screen, synchronously sweep in the same direction to reveal the new page. The lines are horizontal and move downward.

BLINDS_VERT: Multiple lines, evenly spaced across the screen, synchronously sweep in the same direction to reveal the new page. The lines are vertical and move to the right.

BOX_INWARD: A rectangular box sweeps inward from the edges of the page revealing the new page.

BOX_OUTWARD: A rectangular box sweeps outward from the center of the page revealing the new page.

WIPE_LEFT_TO_RIGHT: A single line sweeps across the screen from Left to Right edge of the page

WIPE_BOTTOM_TO_TOP: A single line sweeps across the screen from Bottom to the Top edge of the page

WIPE_RIGHT_TO_LEFT: A single line sweeps across the screen from Right to the Left edge of the page

WIPE_TOP_TO_BOTTOM: A single line sweeps across the screen from Top to Bottom edge of the page

DISSOLVE: The old page "dissolves" gradually to reveal the new one.

GLITTER_LEFT_TO_RIGHT: Similar to Dissolve, except that the effect sweeps across the page in a wide band moving from Left side of the screen to the Right side.

GLITTER_TOP_TO_BOTTOM: Similar to Dissolve, except that the effect sweeps across the page in a wide band moving from Top side of the screen to the Bottom side.

GLITTER_TOPLEFT_TO_BOTTOMRIGHT: Similar to Dissolve, except that the effect sweeps across the page in a wide band moving from TopLeft corner of the screen to the BottomRight corner.

NONE: The new page simply replaces the old one with no special transition effect.

DURATION specifies the duration of the presentation mode (transition effect) in seconds.

OPEN specifies whether the report should be opened after it is generated.

Values:
ON  
   OFF  

EMAIL specifies the report output (defined as FILENAME filename.ext ) to be sent via e-mail as an attachment.

Values:
ON  
OFF  
 
See additional options when EMAIL value is set to ON. EMAIL SET ON


Example
:
   
Example 01 (To print
SalesSumAndSubTot report as secure PDF document)   
PRINT SalesSumAndSubTot +
OPTION PDF +
|
FILENAME SalesSumAndSubTotals.PDF +
|
SHOW_CANCEL_DIALOG ON +
|
BACKGROUND_FILE NONE +
|
BACKGROUND_TYPE CENTER +
|
BACKGROUND_COLOR WHITE +
|
INCLUDE_LINES ON +
|
INCLUDE_SHAPES ON +
|
INCLUDE_RICHTEXT ON +
|
RICHTEXT_ENCODING_TYPE PLAINTEXT +
|
INCLUDE_IMAGES ON +
|
IMAGE_FORMAT JPG +
|
PIXELFORMAT 32 +
|
JPEG_QUALITY 100 +
|
IMAGE_DPI -1 +
|
INCLUDE_HYPERLINKS ON +
|
GENERATE_TOC ON +
|
TITLE Customer Sales Sub-Totals and Totals +
|
SUBJECT Sales Summary Report +
|
AUTHOR Accounting Team of Consolidated Computer Company +
|
KEYWORDS SubTotals Totals Sales Summary +
|
USE_COMPRESSION ON +
|
COMPRESSION_METHOD MAXCOMPRESS +
|
FONT_ENCODING WIN_ANSI +
|
EMBED_USED_FONTS ON +
|
ENCRYPT_FILE ON +
|
USER_PASSWORD RRBYW10 +
|
OWNER_PASSWORD RRBYW10Owner +
|
ENCRYPTION_LEVEL 128BIT +
|
ENABLE_PRINTING OFF +
|
ENABLE_COPYING OFF +
|
ENABLE_MODIFYING OFF +
|
HIDE_TOOLBAR OFF +
|
HIDE_MENUBAR OFF +
|
HIDE_WINDOW_UI OFF +
|
FIT_WINDOW OFF +
|
CENTER_WINDOW OFF +
|
PAGE_LAYOUT SINGLE_PAGE +
|
PAGE_MODE NONE +
|
NON_FULL_SCREEN_PAGE_MODE NONE +
|
PRESENTATION_MODE NONE +
|
DURATION 0 +
|
OPEN ON
RETURN



For more examples and templates, please refer to R:Docs (version 2.5 or higher).