Procedures and functions

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

Procedures and functions

vpxPrint Report Template manages the report, the page skips and the layout, depending on the .

 

 

Procedure name

Type

Notes

MANDATORY

reportInitialize

Procedure

Called on report init:

•settings

•vpxPrint initialization sequence, if needed



 




 



reportHeader

Procedure

Called on the first page of the report

•Put in the stream any valid vpxPrint sequence and text


reportTitle

Procedure

Called when the vpxPrint Report Template needs a title in the current page.

•Put in the stream any valid vpxPrint sequence and text,

•Row cells frames are set by the vpxPrint Report Template

•The height of the title is defined in titleHeight

 

onBeforePage

Procedure

Called before any other processing on the page.

•Put in the stream any valid vpxPrint sequence and text,

•event "on new page"

 

reportRowHeight

Function

Called to evaluate the height of a detail line.

•return the number of rows of the current detail line (decimal or integer value).
vpxPrint Report Template uses this value to evaluate if the line can fit in the available area.
The result is stored in rowHeight

•If this procedure is not defined, the value of rowHeight is used.
You can set this value in reportInitialize, the default is 1

MANDATORY

reportRow

Procedure

Called before processing any detail line.

•Put in the stream any valid vpxPrint sequence and text,

•Row cells frames are set by the vpxPrint Report Template

•<#ROW> is the current vertical bookmark position,

•The height of the detail row is defined in rowHeight

 

onBeforeDrawLines

Procedure

Called before drawing the lines around the array

•Put in the stream any valid vpxPrint sequence and text

•Last entry before drawing the lines.

 

onAfterPage

Procedure

Called after all processing is done in the page.

•Put in the stream any valid vpxPrint sequence and text, just before a page skip or the end of report

 

onBeforeNextPage

Function

Called on next pages, after the title row(s).

•<#ROW> is the current vertical bookmark position,

•Row cells frames are set by the vpxPrint Report Template

•Put in the stream any valid vpxPrint sequence and text,

•Insert any running total

•Return the height (integer or decimal) of the next area


reportFinal

Procedure

Called after the last detail row is processed, before the drawing of lines

•<#ROW> is the current vertical bookmark position,

•Row cells frames are set by the vpxPrint Report Template

•The height of the final area is finalHeight


reportFooter

Procedure

Called on the last page of the report

•Put in the stream any valid vpxPrint sequence and text