Bands

<< Click to Display Table of Contents >>

Navigation:  Programming > WPReporter > Token to Template Conversion >

Bands

Bands are identified by a colon (':') after the opening << characters.

 

Example for header bands:

 

<<:HEADER>>

 

This starts a group header or, if used outside of any group a document header text. In the latter case the following variations are possible:

 

HEADERF = header on first page only

HEADERO =  header on odd pages

HEADERE = header on even pages

HEADER_OFF = this header is disabled.

 

Please note that bands are not implemented using opening and closing tokens ("i.e. <<..>>...<</...>>") so optionally the closing '/' character can be typed: <<:HEADER/>>

 

Example for footer bands:

 

<<:FOOTER>>

 

This starts a group footer or, if used outside of any group a document footer text. In the latter case the following variations are possible:

 

FOOTERF = footer on first page only

FOOTERO =  footer on odd pages

FOOTERE = footer on even pages

FOOTER_OFF = this footer is disabled.

 

Inside header and footer bands fields, images and text is possible. A header and footer band ends where either a different header or footer band starts or a data band:

 

<<:DATA/>>

 

Bands must be the first non white space (white space= space or tab characters) in a paragraph. All text after the band token will be ignored and can be used to write comments.

 

After the name, i.e. HEADERF You can specify an alias value: <<:HEADER "the alias">>

This Alias will be passed to the band event of WPSuperMerge component.

 

Hint: It is also possible to change the names. They are defined in unit WPRTEReport in this array variables:

WPHeaderNames: array[TWPMergeShowOptions] of string =

 ('HEADER', 'HEADERO', 'HEADERE', 'HEADERF', 'HEADERNF', 'HEADERONF', 'HEADER_OFF');

 WPFooterNames: array[TWPMergeShowOptions] of string =

 ('FOOTER', 'FOOTERO', 'FOOTERE', 'FOOTERF', 'FOOTERNF', 'FOOTERONF', 'FOOTER_OFF');

 WPDATANames: array[1..2] of string = ('DATA', 'TEXT');

 

 

You can access the alias name, i.e. "the alias" in band.Alias