Siebel Advisor API Reference > Utility Functions for Siebel Advisor >

ShowHelp

Usage

Use the ShowHelp function to open a separate window displaying the information contained in the \ui\helpset.htm file. The helpset contains information about the application user interface and the controls that it contains, and you can edit the generic information to customize the help for your own application.

You can call the ShowHelp function from any frame within the application, and the function can be executed anywhere a JavaScript function can be used. It is commonly called from the onClick event handler of a link, but it can also be referred to from an image map, set as the SUBMIT method of an embedded frame, or called from another user-defined JavaScript function.

Syntax

ShowHelp()

Notes

• The information that appears when the ShowHelp function is called must be located in the file helpset.htm, and this file must be located in the application ui subdirectory.
• The configuration variable APP_HELP_WIN_ARGS in the Application Configuration file (\custom\app_config.js) defines the attributes of the Help window, including size, whether a status bar, menu bar, and scroll bars appear, and whether the window is resizable.
• The helpset.htm file generated when you create a new project in Advisor contains a frameset that refers to the following source files: help_top.htm, help_mnu.htm, help_ovr.htm, and help_nav.htm. Using a frameset is optional. All of the Help information can appear in the helpset.htm file only.

Example

The following sample code creates a link to the Help window using a link surrounding a button image called btn_hlp.gif.

<A HREF="javascript:''" onClick="ISS.ShowHelp( ); return false;"><IMG src="btn_hlp.gif" alt="browser-based application Help" height=14 width=57 border=0 hspace=0 vspace=0 align=top></A>