Sybernet / Supplied Procedures Reference
Release 3.00
Oct 14, 2002
backwards forwards

HTTP.SP_HTML_MENUBAR

This procedure creates the Sybernet menu bar. It provides a standard and consistent interface for your users that allows them to return to the main menu, change their preferences, access your help text, cancel a request, and logout from Sybernet.

You can override the default Instructions when calling the menubar by specifying the name of the stored procedure that will provide instructions.

Syntax

Procedure SP_HTML_MENUBAR
(
    PROCNAME                      VARCHAR2
,   SEARCH                        VARCHAR2
,   TARGET                        VARCHAR2
,   WIDTH                         VARCHAR2
,   HEIGHT                        VARCHAR2
,   SCROLLBARS                    VARCHAR2
,   RESIZEABLE                    VARCHAR2
,   STATUS                        VARCHAR2
,   GROUPNAME                     VARCHAR2
,   HEADER                        VARCHAR2
,   FOOTER                        VARCHAR2
,   CANCEL                        VARCHAR2
)   ;

Parameters

Parameter Description
procname
 
PROCNAME is the name of the stored procedure that should be executed when the user clicks on the Instructions image on the menubar.
search
 
SEARCH are any arguments that you wish to pass to this procedure; for example, you might wish to have one help procedure defined that displays help text based on the parameter passed to it.

While the SEARCH string could be appended to PROCNAME in the usual way, passing it separately guarantees that this string will be valid because it will automatically be URL Encoded.
target
 
When TARGET is specified, a new window is created which will be used for the output text of your stored procedure. When NULL, output is sent to the same window.
width
 
WIDTH specifies the width of your new window in pixels. The default is 200. WIDTH is ignored if TARGET is NUL
height
 
HEIGHT specifies the height of your new window in pixels. The default is 400. HEIGHT is ignored if TARGET is NULL.
scrollbars
 
SCROLLBARS determines if the new window created will have scroll bars. Allowed values are yes and no. The default is no.
resizeable
 
RESIZEABLE determines if the new window created can be resized. Allowed values are yes and no. The defulat is yes
status
 
STATUS is written to the window's status line when a mouseOver event occurs on this link.
groupname
 
This option allows you to control what menu screen is displayed when a user clicks the Main Menu button. To specify otherwise, attach the fully qualified procedure name that controls this directory.
header
 
Determines (yes or no) if a HR tag is created.
footer
 
Determines (yes or no) if a HR tag is created.
cancel
 
Determines the name of the window (a target) where the cancel results are sent.

Example 1

The first example is how you would direct output of your help procedure to the same window.

        http.sp_html_menubar
        (
            PROCNAME  => 'sp_html_help'
        ,   SEARCH    => 'Step 3'
        ,   STATUS    => 'Click here for information on how to use this tool!'
        )   ;

Notice that the parameter "Step 3" is passed to "sp_html_help."


Example 2

The next example works exactly the same way except that it creates a new browser window to send this information.

        http.sp_html_menubar
        (
            PROCNAME  => 'sp_html_help'
        ,   SEARCH    => 'Step 3'
        ,   TARGET    => 'HelpWindow'
        ,   WIDTH     => '400'
        ,   HEIGHT    => '600'
        )   ;

See Also

SP_HTML_HELPTEXT
SP_HTML_HELPTEXT_SHOW



Sybernet is a trademark of SRI International.
Copyright © 1996-2008 SRI International. All Rights Reserved.
Denis D. Workman / http://Sybernet.sri.com/