R:BASE 11 Help

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

EMAIL

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

GENERATE_TOC

ON

OFF

Specifies whether to generate bookmarks or a "Table of Contents" based on all report Break Headers, if defined.

USE_COMPRESSION

ON

OFF

Specifies whether compression should be used.

COMPRESSION_METHOD

FASTEST

NORMAL

MAXCOMPRESS

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

FONT_ENCODING

WIN_ANSI

MAC_ROMAN

MAC_EXPERT

STANDART

PDF_DOC

Specifies the type of font encoding to be used to encode font.

EMBED_USED_FONTS

ON

OFF

FULL (same as "ON" for backward compatibility)

SUBSET

Specifies whether all the used fonts should be embedded in the PDF document. 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

ON

OFF (default)

Specifies whether the PDF document should be encrypted.

USER_PASSWORD

value

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

value

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

40BIT

128BIT

Specifies the level of encryption of the PDF document. 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

ON (default)

OFF

Specifies whether to allow printing when USER_PASSWORD is set.

ENABLE_COPYING

ON (default)

OFF

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

ENABLE_MODIFYING

ON (default)

OFF

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

ENABLE_ANNOTATION

ON

OFF

Specifies whether the PDF document supports annotation when USER_PASSWORD is set.

ENABLE_FORM_FILL

ON

OFF

Specifies whether the PDF document supports form fill when USER_PASSWORD is set.  

ENABLE_ACCESSIBILITY

ON

OFF

Specifies whether the PDF document supports tagging accessibility when USER_PASSWORD is set.  

ENABLE_DOC_ASSEMBLY

ON

OFF

Specifies whether the PDF document supports document assembly when USER_PASSWORD is set.  

ENABLE_HIRES_PRINT

ON

OFF

Specifies whether the PDF document supports high resolution printing when USER_PASSWORD is set.  

HIDE_TOOLBAR

ON

OFF (default)

Specifies whether to hide the viewer application's toolbars, such as Acrobat Reader, when the document is active. If the value is ON then the viewer applications toolbars are hidden.

HIDE_MENUBAR

ON

OFF (default)

Specifies whether to hide the viewer application's menu bar, such as Acrobat Reader, when the document is active. If the value is ON then the viewer applications menu bar is hidden.

HIDE_WINDOW_UI

ON

OFF (default)

Specifies 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.

FIT_WINDOW

ON

OFF (default)

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.

CENTER_WINDOW

ON

OFF (default)

Specifies 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.

PAGE_LAYOUT

SINGLE_PAGE

ONE_COLUMN

TWO_COLUMN_LEFT

TWO_COLUMN_RIGHT

Specifies the page layout to be used when the PDF document is opened. 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

NONE

OUTLINES

THUMBS

FULLSCREEN

Specifies how the document should be displayed when opened. If the value is set to NONE 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 set to 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

NONE

USE_OUTLINES

USE_THUMB

Specifies how to display the document on exiting full screen mode. This is meaningful only if the PAGE_MODE value is set to  FULLSCREEN. 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

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

Specifies how the PDF viewer application will display/present the document with transition effects. 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. A detailed description of each transition effect is described below.

DURATION

value

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

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 Top Left corner of the screen to the Bottom Right corner.

NONE

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