class Band

Contains the objects to output for a single row in a stream, or the header or footer of a group.

Syntax

These objects are automatically created by the StreamSource and Group objects.

Properties

The following table lists the properties and events of the Band class. (No methods are associated with this class.)

Property	Default	Description
baseClassName	BAND	Identifies the object as an instance of the Band class
beginNewFrame	false	Whether rendering always starts in a new StreamFrame
className	(BAND)	Identifies the object as an instance of a custom class. When no custom class exists, defaults to baseClassName
context	Normal	The context in which the band is being rendered: (0=Normal) or for (1=For Drilldown summary)
expandable	true	Whether the band will increase in size automatically to accommodate the objects within it
firstOnFrame		Whether the band is being rendered for the first time in a StreamFrame.
height	0	The height of the band in the Report object’s current metric units
name		The name of the Band object
parent		The StreamSource or Group object that contains the Band
renderOffset		The offset of the bottom of the band from the top of the current stream frame.
streamFrame		The StreamFrame object in which the band is currently rendering.
visible		Whether the band is visible

Event	Parameters	Description
onRender		After the contents of the band have rendered
preRender		Before the contents of the band are rendered

Description

A Band object acts as a container for visual components. They are created automatically for StreamSource and Group objects and cannot be created manually. There are three kinds of Band objects: detail bands, header bands, and footer bands.

A detail band is assigned to a StreamSource’s detailBand property. The contents of the band are output once for each row in the StreamSource’s rowset. Header and footer bands are assigned to a Group object’s headerBand and footerBand properties respectively. They are rendered at the beginning and end of each group.

For a detail band, setting its beginNewFrame property to true causes each row from the StreamSource’s rowset to be rendered in a new StreamFrame, which is the desired behavior when creating labels.

For a summary-only report, leave the detail band empty and set its height to zero.

When a band’s expandable property is true and it contains components, the band will expand to show those components, even if its height is set to zero.