class StreamSource

Describes a data source for streaming.

Syntax

[<oRef> =] new StreamSource(<report>)

<oRef>

A variable or property—typically of <report>—in which you want to store a reference to the newly created StreamSource object.

The Report object to which the StreamSource object binds itself.

Properties

The following tables list the properties and methods of the StreamSource class. (No events are associated with this class.)

Property	Default	Description
baseClassName	STREAMSOURCE	Identifies the object as an instance of the StreamSource class
className	(STREAMSOURCE)	Identifies the object as an instance of a custom class. When no custom class exists, defaults to baseClassName
detailBand		A Band object that corresponds to the rowset
maxRows		The maximum number of rows the StreamSource will provide per StreamFrame per page
name		The name of the StreamSource object
parent		The Report object that contains the StreamSource
rowset		The Rowset object that drives the StreamSource

Method	Parameters	Description
beginNewFrame( )		Forces the next band to display in a new StreamFrame.
release( )		Explicitly releases the StreamSource object from memory

Description

A StreamSource object acts as the common ground between a rowset that contains data you want to display and a band that contains components to display that data.

Every StreamFrame is assigned a StreamSource. The same StreamSource object may be assigned to multiple StreamFrame objects. The data from a StreamSource is rendered in all the StreamFrame objects that are linked to it. You may limit the number of rows that are rendered per StreamFrame, and therefore per page, by setting the StreamSource object’s maxRows property.

A StreamSource object may contain Group objects that group data to perform aggregate functions.