Class FrameSet() Professional

Class function of the FrameSet class.

Superclass
Description

The Frameset class is derived from the HTML3 class, but its usage is limited to the creation of framesets which consist of more than one HTML file. The HTML code for a single frame is then defined by a Frame object created by a Frameset object. A comprehensive example for framesets is included in the directory ..\samples\waa\frameset. The following steps describe a general usage scenario:

In the HTML startup page, the HTML3 class to be used by the WAA server must be defined:

<INPUT TYPE=hidden NAME="WAA_PACKAGE" VALUE="MyDll"> 
<INPUT TYPE=hidden NAME="WAA_FORM"    VALUE="MyFunc"> 
<INPUT TYPE=hidden NAME="WAA_HTML3CLASS" VALUE="Frameset">

When the value of the hidden variable WAA_HTML3CLASS is set to "Frameset", the WAA server is instructed to pass a Frameset object to the function MyFunc().

The form-function receives the Frameset object and must create Frame objects which, in turn, create the HTML code for each frame:

FUNCTION MyFunc( oFrameset, oContext ) 
   LOCAL oFrame 

   oFrameset:header() 
   oFrameset:beginFrameset( , "50,*" ) 

   oFrame := oFrameset:newFrame( 'Left', 'SCROLLING="NO"', ; 
                                          "/temp/LEFT.HTM" ) 
   oFrame:header() 
   oFrame:put   ( "<p>Left frame</p>" ) 
   oFrame:footer() 

   oFrame := oFrameset:newFrame( 'Right', , "/temp/RIGHT.HTM" ) 

   oFrame:header() 
   oFrame:put   ( "<p>Right frame</p>" ) 
   oFrame:footer() 

   oFrameset:endFrameset() 
   oFrameset:footer() 
RETURN .T. 

A Frame object is created by a the Frameset object with the :newFrame() method. A Frame object is then used in the same way as an HTML3 object for creating HTML output to be displayed in the frame.

The methods of a Frameset object must be called in the following sequence to successfully create a frameset:

:header() 
:beginFrameset() 
:newFrame() 
:newFrame() 
:endFrameset() 
:footer() 

Methods
:header()
Mark the begin of information sent to the Web browser.
:beginFrameset()
Begins a new frameset definition.
:newFrame()
Create a new frame.
:endFrameset()
Ends a frameset definition.
:footer()
Mark the end of a frameset.
:addFrame()
Adds a frame to the frameset.
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.