Siebel Advisor API Reference > Utility Functions for Siebel Advisor >

FrameToOLString


Usage

Use the FrameToOLString function to determine the appropriate Document Object Model (DOM) path to a particular frame.

Browser-based applications establish a virtual document root at ISS. In many instances, you need to define a path relative to ISS. This function performs the necessary translation.

This function returns a string value.

Syntax

FrameToOLString(frame)

Argument
Description

frame

DOM-based window object, returns a string.

Example

The Application UI Definition file (/ui/ol_ui.htm) contains the following reference:

ISS.RegisterUI(ISS.FrameToOLString(window)+'.mainArea')

In a standard browser-based application, this is equivalent to:

ISS.RegisterUI(ISSStr+'.ol_ui.mainArea');

Siebel Advisor API Reference Copyright © 2006, Oracle. All rights reserved.