class StreamFrame

Describes an area on a page into which output is streamed.

Syntax

[<oRef> =] new StreamFrame(<pageTemplate>)

<oRef>

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

The PageTemplate object to which the StreamFrame object binds itself.

Properties

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

Property	Default	Description
baseClassName	STREAMFRAME	Identifies the object as an instance of the StreamFrame class
borderStyle	Default	The border around the StreamFrame object (0=Default, 1=Raised, 2=Lowered, 3=None, 4=Single, 5=Double, 6-Drop Shadow, 7=Client, 8=Modal, 9=Etched In, 10=Etched Out)
className	(STREAMFRAME)	Identifies the object as an instance of a custom class. When no custom class exists, defaults to baseClassName
form		Reference to the report that contains the StreamFrame object
height	0	Height of the StreamFrame object in its PageTemplate’s Report’s current metric units
left	0	The location of the left edge of the StreamFrame object in its PageTemplate’s Report’s current metric units, relative to the PageTemplate’s marginLeft
marginHorizontal	0	Horizontal margin inside the StreamFrame
marginVertical	0	Vertical margin inside the StreamFrame
name		The name of the StreamFrame object
parent		The PageTemplate object that contains the StreamFrame
streamSource		Reference to a StreamSource object that contains objects to be rendered in the StreamFrame
top	0	The location of the top edge of the StreamFrame object in its PageTemplate’s Report’s current metric units, relative to the PageTemplate’s marginTop
width		Width of the StreamFrame object in its PageTemplate’s Report’s current metric units

Event	Parameters	Description
canRender		Before the StreamFrame is rendered; return value determines whether StreamFrame is rendered
onRender		After the contents of the StreamFrame have rendered

Description

A StreamFrame object describes a rectangular region inside the margins of a PageTemplate into which data from a StreamSource object is rendered.

Although you may create multiple StreamFrame objects in a PageTemplate, the Report Designer currently does not support multiple StreamFrame objects visually.