ALTER-REPORT

Function

Alters report-specific functionality.

Syntax

ALTER-REPORT
[HEADING={heading_name_txt_lit|_var|_col]
[HEADING-SIZE={heading_size_int_lit|_var|_col]
[FOOTING={footing_name_txt_lit|_var|_col]
[FOOTING-SIZE={footing_size_int_lit|_var|_col}]
[PDF-APPEARANCE=(appearance_lit|_var|_col)]
[PDF-INFORMATION=(information_lit|_var|_col, value_lit|_var|_col[,information_lit|_var|_col, value_lit|_var|_col]...)]
[PDF-OPEN-ACTION=(openaction_lit|_var|_col, 
[,name_lit|_var|_col,value_lit|_var|_col]...)]
[PDF-PAGE-TRANSITION=(transition_lit|_var|_col, duration_lit|_var|_col)]
[PDF-SECURITY=(security_lit|_var|_col, value_lit|_var|_col[,security_lit|_var|_col, value_lit|_var|_col]...)]
[PDF-VIEWER-PREFERENCE=(preference_lit|_var|_col, value_lit|_var|_col[,preference_lit|_var|_col, value_lit|_var|_col]...)]

Arguments

HEADING

Name of the BEGIN-HEADING section.

HEADING-SIZE

Amount of space occupied by the BEGIN-HEADING section.

FOOTING

Name of the BEGIN-FOOTING section.

FOOTING-SIZE

Amount of space occupied by the BEGIN-FOOTING section.

PDF-APPEARANCE

Appearance of the document when opened.

Table 7. Appearance Values

Appearance	Description
None	Neither bookmarks nor thumbnails are visible. (Default value when the document does not contain bookmarks.)
Bookmarks	Opens documents with bookmarks visible. (Default value when the document contains bookmarks.)
Thumbnails	Opens documents with thumbnails visible.
Fullscreen	Opens in full-screen mode. (This value does not work in the browser.)

For example:

ALTER-REPORT
  PDF-APPEARANCE=('None')

PDF-INFORMATION

The information name to address and the data to apply to the information parameter. You can specify any of the standard information names shown in Table 8, or you can specify any user-defined name with the exception of the following names which are reserved by the PDFlib: CreationDate, Producer, ModDate, or Trapped.

Table 8. Standard PDF Information Names

Name	Description
Subject	Document subject.
Title	Document title. (The default is the product name and version string.)
Creator	Software used to create the document.
Author	Document author.
Keywords	Keywords describing the document contents.

For example:

ALTER-REPORT
  PDF-INFORMATION=('Author', 'Peter Burton', 'Keywords', 'Sample   Private')

PDF-OPEN-ACTION

Action the PDF viewer takes when opening a file, name of the additional value, and value to apply.

Table 9. Open Actions

Open Action	Description
Fixed	Use a fixed destination view defined with Zoom, Left, and Top.
Window	Fit the complete page to the window.
Width	Fit the page width to the window defined with Top.
Height	Fit the page height to the window defined with Left.
Rectangle	Fit the rectangle defined with Left, Bottom, Right, and Top.
Visible	Fit the visible contents of the page to the window.
VisibleWidth	Fit the visible contents of the page to the window defined with Top.
VisibleHeight	Fit the visible contents of the page to the window defined with Left.

Table 10. Additional Values

Value	Description
Page	Initial page to display. (default = 1)
Zoom	Zoom factor to use when the page displays. (default =100)
Left	Column number of the page to position at the left edge of the window. (default = 1)
Top	Line number of the page that will be positioned at the top edge of the window. (default = 1)
Bottom	Last line of the page to display. (default = entire page)
Right	Last column of the page to display. (default = entire page)

For example:

ALTER-REPORT
  PDF-OPEN-ACTION=('Fixed', 'Zoom, 75, 'Page', 2)

PDF-PAGE-TRANSITION

Page transition for current and future pages and the duration (in seconds) for the transition.

Table 11. Transitions

Transition	Description
Split	Two lines sweeping across the screen reveal the page.
Blinds	Multiple lines sweeping across the screen reveal the page.
Box	A box reveals the page.
Wipe	A single line sweeping across the screen reveals the page.
Dissolve	The old page dissolves to reveal the new page.
Glitter	The dissolve effect moves from one screen edge to another.
Replace	The old page is replaced by the new page. (default value)

For example:

ALTER-REPORT
  PDF-PAGE-TRANSITION=('Wipe', 3.25)

PDF-SECURITY

Security parameter to address and value to apply to the security parameter.

Table 12. Security Parameters

Security	Description
User-Password	User level password applied to the generated PDF. Up to 32 characters. Needed to open the document.
Master-Password	Master level password applied to the generated PDF. Up to 32 characters. Used to open documents or override the permissions.
Permissions	Permissions applied to the generated PDF. NoPrint—Prevents printing the file. NoModify—Prevents users from adding form fields or making any other changes. NoCopy—Prevents copying and extracting text and graphics and disables the accessibility interface. NoAnnots—Prevents adding or changing comments or form fields. NoForm—Prevents form field filling, even if NoAnnots is not specified. (Requires Acrobat 5 or higher) NoAccessible—Prevents extracting text or graphics for accessibility purposes. For example, a screen reader program.(Requires Acrobat 5 or higher) NoAssemble—Prevents inserting, deleting, or rotating pages and creating bookmarks and thumbnails, even if NoModify is not specified. (Requires Acrobat 5 or higher) NoHiResPrint—Prevents high-resolution printing. If NoPrint is not specified, printing this setting is restricted to the Print As Image feature, which prints a low-resolution rendition of the page. (Requires Acrobat 5 or higher)

Note:

Default documents have no passwords and all permissions.

For example:

ALTER-REPORT
  PDF-SECURITY=('User-Password', $User_Password, 
  'Master-Password', &Master_Password, 'Permissions', 'NoPrint NoCopy')

PDF-VIEWER-PREFERENCE

Viewer preference to address and value to apply to the preference.

Table 13. Viewer Preferences

Preference	Description
Toolbar	True hides Acrobat’s tool bar. Default = False
MenuBar	True hides Acrobat’s menu bar. Default = False
WindowUI	True hides Acrobat’s windows controls. Default = False
FitWindow	True resizes the document’s window to the size of the first page. Default = False
CenterWindow	True positions the document’s windows in the center of the screen. Default = False
DisplayDocTitle	True displays the document information field in Acrobat’s title bar; False displays the file name. Default = False
NonFullscreen-PageMode	How to display the document on exiting full-screen mode: UseOutlines–Displays page and document outlines. UseThumbs–Displays page and thumbnails. UseNone–Displays neither document outlines nor thumbnails. Default = UseNone
Direction	Reading order of the document. (Affects scroll ordering in double-page view.) L2R–Left to right R2L–Right to left (including vertical writing systems). Default = L2R

For example:

ALTER-REPORT
  PDF-VIEWER-PREFERENCE=('Direction', 'R2L')

Description

ALTER-REPORT dynamically changes how much space active heading and/or footing sections occupy for the current report. For PDF reports, you can add information about the report, control the display and appearance of the report, and control security settings.

If HEADING or FOOTING = ‘NONE’, the section is disabled for the current report.

If HEADING or FOOTING = ‘DEFAULT’, the section reverts to whatever was in effect when the report was initiated.

If no HEADING or FOOTING value is set HEADING-SIZE and/or FOOTING-SIZE values affect the HEADING/FOOTING currently used.

When HEADING, HEADING-SIZE, FOOTING, or FOOTING-SIZE is defined: the command is not invoked in a BEGIN-HEADING and/or BEGIN-FOOTING section, the page is not written to, and the assignment takes effect immediately. Otherwise, it takes effect for the next page.

Examples

begin-footing 2 name=confidental
  print 'Company Confidential' (1,1,0) center
  page-number (2,37,0)
end-footing

begin-footing 2 name=proprietary
  print 'Company Proprietary' (1,1,0) center
  page-number (2,37,0)
end-footing

begin-program
  .
  .
  .
  alter-report 
    footing = 'Proprietary'
    footing-size = 6       ! Increase depth
  .
  .
  .
end-program