Siebel Advisor API Reference > User Interface Layout and Control Functions for Siebel Advisor >
RegisterPageLocation
Usage
Use the RegisterPageLocation function to map specific display pages into the frames defined for a pageset. This function is always called from the Pageset UI Registry file (\pg\pagesetID_i.htm). This function also defines which pages are visible when the pageset first loads. You must call the RegisterPageLocation function once for each display page in the pageset, even if a page is not initially visible. You can rotate two or more display pages through a single pageset frame. Syntax
RegisterPageLocation(fileName,frameName,isVisible,[path]);
|
|
fileName |
Name of the HTML display page. |
frameName |
Name of the frame in which the HTML display page appears. |
isVisible |
String that indicates whether or not the file is visible when the pageset first loads ("true" = visible, "false" = invisible). |
Path |
Optional. The full path to the directory (pg by default) containing HTML file. |
Example
The following sample code registers the dogs.htm display page (located in the pg directory) into the ui_disp nested frame of the main display page frame (mainArea). ISS.RegisterPageLocation("dogs.htm", ISS.GetPagesetDisplayArea()+".uidisp","true");
The following example registers a display page that is located in the ui directory instead. ISS.RegisterPageLocation("dogs.htm", ISS.GetPagesetDisplayArea()+".ui_disp","true",ISS.GetUIPath());
Related Topics
Example of Defining a Pageset Layout
|