Sybernet / Supplied Procedures Reference
Release 3.00
Apr 19, 2003
backwards forwards

HTTP.SP_HTML_VI

This procedure allows you to create an edit window. VI uses this procedure and contains other useful information about user preferences and what the buttons mean. When invoking sp_html_vi yourself, you have more control on how the table is rendered; for example, you can specify the table's background color, border, and border color.

You also have the ability to set user preferences when invoking sp_html_vi. This can be tricky because all of Boolean options can be in one of four forms: true, false, null, and unspecified. True means set this option, false means reset this option, null means leave the option alone, and unspecified means use the default setting of sp_html_vi. If you do not want to override a user's preference, then you should explicitly specify null for this parameter.


Syntax

Procedure SP_HTML_VI
(
    BUTTON                        VARCHAR2
,   OWNER                         VARCHAR2
,   TABLE_NAME                    VARCHAR2
,   ROW_ID                        VARCHAR2
,   TARGET                        VARCHAR2
,   TITLE                         VARCHAR2
,   TOPMARGIN                     VARCHAR2
,   LEFTMARGIN                    VARCHAR2
,   CAPTION                       VARCHAR2
,   BORDER                        VARCHAR2
,   WIDTH                         VARCHAR2
,   BORDERCOLOR                   VARCHAR2
,   CELLPADDING                   VARCHAR2
,   CELLSPACING                   VARCHAR2
,   BGCOLOR                       VARCHAR2
,   ALIGN                         VARCHAR2
,   VALIGN                        VARCHAR2
,   THBGCOLOR                     VARCHAR2
,   TDBGCOLOR                     VARCHAR2
,   VERBOSE                       VARCHAR2
,   RESETSCREEN                   VARCHAR2
,   RESETROWID                    VARCHAR2
,   SAVEANDSCROLL                 VARCHAR2
,   LANDSCAPE                     VARCHAR2
,   LINES                         NUMBER
,   MAXTAGSIZE                    NUMBER
,   ONLOAD                        VARCHAR2
)   ;

Parameters

Parameter Description
button
 
Button should be null.
owner
 
Owner is the owner of the table you want to edit.
table_name
 
Table_name is the name of the table you want to edit.
row_id
 
row_id should be NULL. sp_html_vi uses this to determine the current rowid.
target
 
Target should be NULL. sp_html_vi uses this to determine the current search screen.
title
 
Title is the title of this page. title should be specified if sp_html_vi is not being invoked from a frame.
topmargin
 
Topmargin determines the topmargin (or MARGINHEIGHT) for your table.
leftmargin
 
Leftmargin determines the leftmargin (or MARGINWIDTH) for your table.
caption
 
Specifies a caption for each table.
border
 
Specifies the table's border size.
width
 
Specifies the table's width.
bordercolor
 
Specifies the table's border color.
cellpadding
 
Specifies the cell padding. Cellpadding is 0 when in landscape mode.
cellspacing
 
Specifies the cell spacing. Cellspacing is 0 when in landscape mode.
bgcolor
 
Specifies the background color of your table.
align
 
Specifies how the table should be aligned.
valign
 
Specifies the vertical alignment of each table data.
thbgcolor
 
Specifies the background color of your table's heading. In portrait mode, THBGCOLOR is ignored.
tdbgcolor
 
Specifies the background color of your table's data.
verbose
 
Verbose mode.
resetscreen
 
Clear screen data and enter insert mode after save.
resetrowid
 
Save screen data and enter insert mode after save.
saveandscroll
 
Scroll forward and enter update mode after save.
landscape
 
Landscape mode.
lines
 
Number of rows to render when landscape is true.
maxtagsize
 
In landscape mode this option determines the maximum tag size that can be built. The default is 20.
onload
 
onLoad is used internally, but you can also pass this to sp_html_vi.


Example

The following example illustrates how to call sp_html_vi:

HTTP.SP_HTML_VI
(
    BUTTON                        => NULL
,   TABLE_NAME                    => 'CRON_PARAMETERS'
,   OWNER                         => 'HTTP'
,   THBGCOLOR                     => 'lightblue'
,   TDBGCOLOR                     => NULL
,   BGCOLOR                       => NULL
,   BORDER                        => 5
,   BORDERCOLOR                   => 'white'
,   CAPTION                       => '<h2>HTTP.CRON_PARAMETERS</h2>'
,   VERBOSE                       => NULL
,   RESETSCREEN                   => NULL
,   RESETROWID                    => NULL
,   SAVEANDSCROLL                 => NULL
,   LANDSCAPE                     => 'true'
,   LINES                         => 8
,   ALIGN                         => 'center'
,   MAXTAGSIZE                    => 60
)


See Also

MYSELF
SP_HTML_PREFERENCES
VI



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