Siebel Advisor API Reference > Contents List Functions for Siebel Advisor >

SetContentsListFrame

Usage

Use the SetContentsListFrame function to redefine the Contents List display frame while the application is running.

The Contents List frame is originally set during application startup through a call to RegisterContentsListFrame. The SetContentsListFrame function redefines where the Contents List appears while the application runs.

SetContentsListFrame can be called anytime the application is running. It is usually called at the pageset level, from Pageset UI Registry file (\pg\pagesetID_i.htm). You must give the full path to the frame, relative to the top of the application.

You must make sure that the target frame exists at the time the Contents List is loaded into it. Because each pageset can have its own set of frames, it is easy to reference a frame that no longer exists or does not yet exist.

Syntax

SetContentsListFrame(frameName)

Example

The following sample code uses SetContentsListFrame to reset the Contents List location to a frame named uidata, located inside a pageset frameset. The two examples are equivalent, but the first example is preferred.

ISS.SetContentsListFrame(ISS.GetPagesetDisplayArea()+".uidata")

or

ISS.SetContentsListFrame(ISS.GetVisibleDisplayArea()+".mainArea.uidata")

See Also

FrameToOLString.

RegisterContentsListFrame.