Documents > BPS V2 Script API
report::Page Class Reference

Report pages can only be created by report.addPage(). More...

Public Member Functions

void appendSection (Section aSection)
 Appends a section to the end of the page.
void insertSection (Number aIndex, Section aSection)
 Inserts a section to the page.
Number printHeight ()
Section sectionAt (Number aIndex)
 Get the existing section object at a certain index.
Number sectionCount ()

Detailed Description

Report pages can only be created by report.addPage().

Member Function Documentation

void report::Page::appendSection ( Section  aSection)

Appends a section to the end of the page.

New sections can be created by report.createSection().

Parameters
[in]aSectionThe section to append.
void report::Page::insertSection ( Number  aIndex,
Section  aSection 
)

Inserts a section to the page.

New sections can be created by report.createSection() .

Parameters
[in]aIndexThe position where the section shall be inserted. Must be in range 0 ... sectionCount() .
[in]aSectionThe section to insert.
Exceptions
ErrorWhen invalid position provided.
Number report::Page::printHeight ( )
Returns
The sum of all section print heights.
Section report::Page::sectionAt ( Number  aIndex)

Get the existing section object at a certain index.

Parameters
[in]aIndexThe section index, it must be in the range 0 ... sectionCount()-1.
Returns
Returns the section object.
Exceptions
ErrorWhen invalid index provided.
Number report::Page::sectionCount ( )
Returns
Number of sections in the page.