Main Content

Page Header

Insert a page header in a form-based report

Description

Generates a page header in a Word or PDF report. A template associated with this component defines its fixed content and format and holes for filling the header with generated content. You can use this component to generate up to three types of headers per section: one for the first page, one for odd pages, and one for even pages.

You can define your report’s page headers in templates. When you assign a template that defines headers to your report’s Report Form or a Subform component, the Report Generator creates a Page Footer component for each page footer defined in each page layout defined by the template. It appends the page footer components that it creates for a particular template-defined page layout to the page layout component that it generates for that template-defined layout.

In addition to defining page headers in your templates, you can define them directly in the Report Explorer. For example, you can:

  • Create page layout components in the Report Explorer and add header components to them.

  • Add headers to layouts defined in your templates.

  • Change the templates assigned to headers defined in your report templates.

The Report Generator generates a Template Hole component for each hole defined by a page header template. Every header has at least one hole component, a #start# component. You can define additional holes in the template that defines the header. You can add content to a header by appending components to the header holes in your report setup. The Report Generator generates header content by executing its hole components when it generates the parent page layout. The generated content applies to all pages of the specified header type. This means that you cannot use the Report Explorer to generate the header content for specific pages. You can, however, use Word and PDF fields, such as page number fields, in header templates to generate page numbers and other kinds of content that varies from page to page in a section.

To understand how layouts work, see Define Page Layouts in a Form-Based Report Setup.

Page Header Options

The options indicate the type of page the header applies to and the template that defines the header’s form.

  • Page type: The type of page in this page layout that the header applies to.

    • Default: Header for odd pages of the section, even pages if you do not specify an even-page footer, and the first page if you do not specify a first-page footer.

    • Even: Header for even pages of the section.

    • First: Header for the first page of the section.

  • Template type: Specify the template that defines the header content.

    • Library: Select Library to select a template from a document part library. When you select this option, the Source Library Options appear.

    • File: Select File to select a template file as the source of the header content.

    • Page Layout: This option appears if the Page Header component was based on a header in the template assigned to a Report Form or Subform component in your report setup.

  • Source Library Options: If you select Library as the template type, you can set these options.

    • Report form library: Template library of the template file assigned to this report setup’s Report Form component.

    • Parent subform library: Template library used by the Subform that contains this Header component. This option appears only if this component is a descendant of a Subform component and the parent subform uses a library as the source of its template.

    • Other library: Template library of a specified template file.

  • Template: If the template type is File, this option specifies the name of the template file that defines the header associated with this component. If the template type is Library, this option specifies the template file that contains the template library to use as the source for this component’s template. This option appears only if you select Library as your template type and Other library as the source of the library.

  • Library template name: Name of a template that resides in the template library used by this component.

Insert Anything into Report?

Yes, inserts a page header

Class

rptgen.cform_page_header