class PageTemplate

Describes the layout of a page of a report.

Syntax

[<oRef> =] new PageTemplate(<report>)

<oRef>

A variable or property—typically of <report>—in which you want to store a reference to the newly created PageTemplate object.

The Report object to which the PageTemplate object binds itself.

Properties

The following tables list the properties and methods of the PageTemplate class. (No events are associated with this class.)

Property	Default	Description
background		Background image on the page
baseClassName	PAGETEMPLATE	Identifies the object as an instance of the PageTemplate class
className	(PAGETEMPLATE)	Identifies the object as an instance of a custom class. When no custom class exists, defaults to baseClassName
colorNormal	white	Background color for the page
gridLineWidth	0	Width of lines around elements in the report (0=no grid lines)
height		Height of the page in current metric units
marginBottom	.75 inch = 1080 twips	The space between the bottom of the page and the usable area of the PageTemplate
marginLeft	.75 inch = 1080 twips	The space between the left side of the page and the usable area of the PageTemplate
marginRight	.75 inch = 1080 twips	The space between the right side of the page and the usable area of the PageTemplate
marginTop	.75 inch = 1080 twips	The space between the top of the page and the usable area of the PageTemplate
name		The name of the PageTemplate object
nextPageTemplate		The PageTemplate object that is used for the following page
parent		The Report object that contains the PageTemplate
width		Width of the page in current metric units
Method	Parameters	Description
release( )		Explicitly releases the PageTemplate object from memory

Description

A PageTemplate object describes the layout of a page, including its background color or image. It acts as a container for StreamFrame objects and visual components, which represent fixed output, such as a report date and page number.

The location of these objects is relative to (and restricted by) the four margin- properties that dictate the usable area of the page. Changing the marginLeft or marginTop will move everything that’s inside the PageTemplate. A PageTemplate’s dimensions - it’s height and width - correspond to your printer’s current Paper Size settings.

Although you may create multiple PageTemplate objects in a report, for example a different first page or alternating odd and even pages, the Report Designer currently does not support multiple PageTemplate objects visually.

In the Report Designer, the dotted area represents the useable portion of the PageTemplate, with the surrounding white area indicating the margins. The Report Designer shows only that area which corresponds to a PageTemplate.