Bookshelf v8.1/8.2: RegisterFrameSet

Use the RegisterFrameSet function to identify the file that contains the pageset UI definition frameset. This function is always called from the Pageset UI Registry file (\pg\pagesetID_i.htm). Each Pageset UI Registry file must contain a RegisterFrameSet function call.

Each pageset must point to a Pageset UI Definition file (located in the pg directory) that defines how to subdivide the pageset display area defined in the Application UI Definition file (\ui\ol_ui.htm). More than one pageset can point to the same Pageset UI Definition file, or each pageset can have its own UI definition. RegisterFrameSet identifies the HTML file that is loaded into this area. This HTML file must always contain a frameset definition that indicates how to subdivide the space.

Syntax


Argument	Description
name	An identifier. When the pageset UI definition frameset finishes loading, it calls a registration function that passes name as one of its arguments. Usually, this identifier name is the same as the name of the HTML file that contains the frameset.
frameSetName	Name of the HTML file containing the frameset.
frameLoc	A string. This argument is the fully qualified name of the target frame into which the frameset will be loaded. In standard applications, this refers to the mainArea frame defined in the Application UI Definition file (\ui\ol_ui.htm).
path	Optional. This argument is the full path to the directory in which the HTML file resides (pg, by default).

Example

The following sample code uses RegisterFrameSet to load the dogs_ui.htm Pageset UI Definition file into the mainArea frame of an application.

The following example points to a frameset file that is located in the ui directory.

ISS.RegisterFrameSet("dogs_ui","dogs_ui.htm",
ISS.GetPagesetDisplayArea(),ISS.GetUIPath());

RegisterFrameSet

Usage

Syntax

Example

Related Topics

Siebel Advisor API Reference		Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.