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

Report sections can only be created by report.createSection(). More...

List of all members.

Public Member Functions

Item item (String aName)
 Get the first item with this name.
Item itemAt (Number aIndex)
 Get the item at a certain index.
Number itemCount ()
Number printHeight ()

Detailed Description

Report sections can only be created by report.createSection().


Member Function Documentation

Item report::Section::item ( String  aName)

Get the first item with this name.

If a section contains multiple items with same name the items should be searched using itemAt() instead, unless you really only need the first one.

Parameters:
[in]aNameThe item name.
Returns:
Returns the item object.
Exceptions:
ErrorWhen no item with this name was found.
Item report::Section::itemAt ( Number  aIndex)

Get the item at a certain index.

Parameters:
[in]aIndexThe item index. Must be in the range 0 ... itemCount()-1.
Returns:
Returns the item object.
Exceptions:
ErrorWhen invalid index provided.
Number report::Section::itemCount ( )
Returns:
Number of items in the section.
Number report::Section::printHeight ( )
Returns:
The height in millimeters required to print the section.