Untitled

NETVIOS WEBFACES TECHNICAL MANUAL

General Syntax

The general syntax for invoking the NetVIOS element, using ASP scripting is shown below:

Set objform = Server.CreateObject("ubvios.formitem")

where objform is an name to be assigned to the element object

To set a property

objform.Property = somevalue

To invoke an action

objform.Action argument1, argument2, …

Element Properties

The GUI element has the following properties:

Name
DataType
FieldSize
GUIType
Label
Value
DefaultValue
RequiredInput
OptionList
OptionValues
SessionVariable
Display
EventResponse
DataTable
DataField
FormName
DoValidation
MaxSize
MaxCharacters

The function and use of these properties are explained below. In the next section, the uses of each function are explained in detail for each element type.

Name
This is the name of the form element. Acceptable values are character strings. Used by display and validation functions.

DataType
Integer, Real, Boolean, Date, Time, String. Used only by validation functions.

FieldSize
Accepts integer values. Used in determining the display size of GUI elements. Used only by display functions.

GUIType
The element type. An exhaustive list follows in the next section. Used by display and validation functions.

Label
An optional label to preface the form element.

Value
The initial value of the form element

DefaultValue
A value to use as the initial value if no initial value is provided

RequiredInput
True of False. When this property is set on, the form label is prefixed with an asterisk. General validation functions are activated to ensure that the user provides a value prior to submitting the form.

OptionList
Used to provide a list for display for certain dropdown or button element types

OptionValues
Used to provide a list of values for certain dropdown or button element types

SessionVariable
An optional character variable corresponding to a session variable which will be used to store the form values

Display
True or false. If set to false the form element is not displayed and no validation functions are generated for the element.

EventResponse
A string representing a javascript command or function name that will be called when the element’s event is activated

FormName
Name of the form to which the element belongs. This input is mandatory only for certain elements that activate additional dialog boxes for input. These includes the file and image elements, upload elements, and the richtextarea element. If the entire form was started using the FormBegin method with a name for the form, then this property is redundant for all the elements belonging to the form.

MaxSize
Maxium display width of all GUI elements of the form

MaxCharacters
Maximum characters allowed for textarea and rich textarea GUI elements. Used only by validation functions

PRESENTATION

GUI Element	Rendering	Availability
Background	Input textbox with max size of 250 characters. Places a button next to the textbox that allows the selection of a file on the website from a pop-up dialog box	Complete NetVIOS program only
Button	Array of Radio buttons. Button labels are determined from list supplied in the OptionList property. The values of the selection are supplied in the OptionValues property.
ButtonQ	Array of radio buttons. Array is determined from an SQL string supplied with the OptionValues properties
CheckBox	Array of checkboxes. Checkbox labels are determined from list supplied in the OptionList property. The values of the selection are supplied in the OptionValues property.
CheckBoxQ	Array of checkboxes. Array is determined from an SQL string supplied with the OptionValues properties
Color	Input text box of size 8 characters. Places a button next to the textbox that allows the selection of a color from a pop-up dialog box
Date	2-digit textbox for day, dropdown selection for month, and 4-digit textbox for year
Dimension, Dimensions
DropDown	Selection. Options are determined from list supplied in the properties
DropDownQ, DropDownQA, DropDownQE	Selection. Options displayed are determined from an SQL string supplied with the OptionList property. Options selected are determined from the OptionValues property. For DropDownQ, the default selection is "-", for DropDownQA it is "Any", and for DropDownQE it is "Every"
EditArea, Editbox, Richtext	NetVIOS rich editbox. WYSIWYG html edit area
Email	Input textbox with max size of 250 characters.
File, FilePath	Input textbox with max size of 250 characters. Places a button next to the textbox that allows the selection of a file on the website from a pop-up dialog box	Complete NetVIOS program only
FolderPath	Input textbox with max size of 250 characters. Places a button next to the textbox that allows the selection of a folder on the website from a pop-up dialog box	Complete NetVIOS program only
Font	Selection. Options are font names
FontSize	Selection. Options go from 1-7
FontStyle	Selection. Options are bold, italic, underline, or strikethrough
HAlign	Selection. Options are Left, Right, Center, or Justify
Image, IconFile	Same as FilePath	Complete NetVIOS program only
ImageBtn	Same as Image except that it contains an additional button that enables a button to be selected from a library of buttons.	Complete NetVIOS program only
Input	Input textbox
Listbox	Multiline selection box. Options displayed are determined from list supplied in the OptionList property. Option values are determined from the OptionValues property.
ListboxM	Same as Listbox except that it allows selection of multiple choices
ListboxQ, ListboxQA, ListBoxQE	Multiline selection box. Options are determined from an SQL string supplied with the OptionValues property. For ListboxQ, the default selection is "-", for ListboxQA it is "Any", and for ListboxQE it is "Every"
ListboxMQ, ListboxMQA, ListBoxMQA	Same as ListboxQ, ListboxMQA, and ListboxMQE except that it allows selection of multiple choices
Month	Dropdown selection for month	Checks that a month is selected
MonthYear	Dropdown selection for month, and 4-digit textbox for year	Checks that the year value is an integer
Password	Two password textboxes.	Verifies that the same values are entered in both boxes
PasswordP	Password textbox
Role, RoleE	Dropdown box to select from a list of defined roles on the site. The default selection is "-". With RoleE, the default selection is "Every"	Complete NetVIOS program only
Size	Input textbox
TextArea, Memo	Text area
Time	Dropdown selection for hour, and dropdown selection for minute
UploadFile, UploadUnique	Input textbox with max size of 250 characters with an adjacent Upload button that prompts the user for a local file to upload. UploadUnique uploads the file on to the webserver with a unique file name.
UploadPick, UploadPickUnique	Input textbox with max size of 250 characters with an adjacent Upload button that prompts the user for a local file to upload and another adjacent GetFile button for selecting the file from the files on the webserver. UploadPickUnique uploads the file on to the webserver with a unique file name.	Complete NetVIOS program only
UploadOnly, UploadOnlyUnique	Upload button that prompts the user for a local file to upload. UploadOnlyUnique uploads the file on to the webserver with a unique file name.
URL	Input textbox with max size of 250 characters
User, Users	Input textbox with max size of 250 characters. Places a button next to the textbox that invokes a pop-up dialog box for the selection of the user from the list of site members	Complete NetVIOS program only
UserTye, UserTypeA	Dropdown box to select from a list of defined user types on the site. The default selection is "-". With UserTypeA, the default selection is "Any"	Complete NetVIOS program only
VAlign	Selection. Options are Top, Middle, Bottom
Week, FullWeek	Selection. Options are Mon, Tue, …, Sun. For FullWeek the options are Monday, Tuesday, …, Sunday
Year	4-digit textbox	Checks that a year value is provided. Checks that the value provided is an integer

Non-Active Elements

Hidden	Generates a hidden form element
Label	Generates a label field element
Rule	Horizontal rule

Element Presentation Actions

DisplayItem –generates presentation of the element in input mode.

ViewItem – generates presentation in preview or result mode

GetItemAsText – returns presentation in text preview mode.

Form Management Actions

BeginForm – generates sections that begins a form

EndForm – generates sections that concludes a form

SubmitForm – generates a submit button for the currently active button

Syntax

DisplayItem

Object.DisplayItem ([imaxsize], [error]

imaxsize – maximum size to be assigned to GUI elements in form. If No value is supplied, defaults to the value provided with the MaxSize property.
ierror – optional variable used to return an error code if one occurs.

For the presentation structures generated by DisplayItem to function like a form, DisplayItem should be called within a form or within a set of BeginForm and EndForm calls. A form can also be opened and closed directly with html syntax (Actually, NetVIOS presentation functions can be called mixed with html as desired).

ViewItem

Object.ViewItem ([imaxsize], [error])

imaxsize – maximum size to be assigned to GUI elements in form.
ierror – optional variable used to return an error code if one occurs.

GetItemAsText

String = Object.GetItemAsText ([imaxsize], [error])

imaxsize – maximum size to be assigned to GUI elements in form.
ierror – optional variable used to return an error code if one occurs.

BeginForm

Object.BeginForm ([FormName], [FormMethod], [FormAction], [OnSubmitText])

FormName – name to assign to form. If a value is provided, also sets the FormName property with this value. If none is specified, defaults to the FormName property. Otherwise, the form is implemented without a name.

        FormMethod – takes on two values – "POST" or "GET". Defaults to "POST".
        FormAction – file to submit form to. Defaults back to the current file.
        OnSubmitText – string representing a client-side javascript construction. Could be a javasscript command, a set of javascript commands separated by ";", or a javascript function call.

EndForm

Object.EndForm()

SubmitForm

Object.SubmitForm([Caption], [Name], [OnClickText])

        Caption – Submit button caption
        Name – Submit button name
        OnClickText – string representing a client-side javascript construction.

VALIDATION

NetVIOS validation is performed on the client-side prior to submitting the form. Validation functions for each element must be called within javascript sections or be preceded by BeginValidation and EndValidation commands.

Validation of elements is of two types – general validation and specific validation. General validation is performed if the RequiredInput property of the element is set to true.

General Validation

General validation involves verifying that a value has been provided for the element before the form is submitted. In addition, the provided input is tested for conformance with the DataType property.

Specific Validation

This is dependent on element type. Specific validation will be performed once an input is provided even if the RequiredInput property is not on. The table below includes description of specific validation options for each element.

GUI Element	General Validation Action	Specific Validation Action
Background	Verifies a value is provided
Button, ButtonQ	Verifies a button in the set is clicked
CheckBox, CheckBoxQ	Verifies a button in the set is clicked
Color	Verifies a value is provided	Checks that input is in the form #RRGGBB, R, G, or B could be values 0-9, A-F
Date	Verifies a value is provided for day, a selection is made for month and a value is provided for year. Checks that the day and year are integer values.	Checks that the date is valid (eg. 30 Feb 2002 is not a valid date).
Dimension, Dimensions	Verifies a value is provided	Checks that the value is an integer or percentage (10 or 10% are both acceptable input)
DropDown	Verifies a value is selected
DropDownQ, DropDownQA, DropDownQE	Verifies a value is selected
EditArea, Editbox, Richtext	Verifies a value is typed in.	Checks that the number of characters does not exceed the value supplied with the MaxCharacters property. If no value is supplied defaults to 4000 characters.
Email	Verifies that a value is provided	Checks that the email is a valid email address (in format)
File, FilePath	Verifies that a value is provided
FolderPath	Verifies that a value is provided
Font	Verifies that a value is selected
FontSize	Verifies that a value is selected
FontStyle	Verifies that a value is selected
HAlign	Verifies that a value is selected
Image, IconFile	Verifies that a value is provided
ImageBtn	Verifies that a value is provided
Input	Input textbox
Listbox	Verifies that a value is selected
ListboxM	Verifies that a value is selected
ListboxQ, ListboxQA, ListBoxQE	Verifies that a value is selected
ListboxMQ, ListboxMQA, ListBoxMQA	Verifies that a value is selected
Month	Verifies that a value is selected	Checks that a month is selected
MonthYear	Verifies that a value is selected for the month and a value provided for the year.	Checks that the year value is an integer. Checks that the year is entered as four digits
Password	Verifies that a value is provided for both password boxes	Verifies that the same values are entered in both boxes
PasswordP	Verifies that a value is provided
Role, RoleE	Verifies that a value is selected
Size	Verifies that a value is provided	Checks that the value is an integer
TextArea, Memo	Verifies a value is typed in.	Checks that the number of characters does not exceed the value supplied with the MaxCharacters property. If no value is supplied defaults to 4000 characters.
Time	Verifies that a value is selected for the hour and minute selection boxes
UploadFile, UploadUnique	Verifies that a value is provided
UploadPick, UploadPickUnique	Verifies that a value is provided
UploadOnly, UploadOnlyUnique	Verifies that a value is provided
URL	Verifies that a value is provided
User, Users	Verifies that a value is provided
UserType, UserTypeA	Verifies that a value is selected
VAlign	Verifies that a value is selected
Week, FullWeek	Verifies that a value is selected
Year	Verifies that a value is provided. Checks that the value provided is an integer	Checks that the year is entered as a four digit year

Validation Actions

Validation may be inserted within StartValidation and EndValidation actions. Validation may alternatively be inserted within html/javascript sections to start and end validation. Validation for each GUI element is generated with the ValidateItem action.

Syntax

StartValidation

Object.StartValidation ([Form_Name])

Form_Name – name of the form. When provided, this also sets the FormName property. May be omitted it the name of the form has already been set with the FormName property. In all cases, a form name must be provided for validation commands to be successful

EndValidation

Object.Validation()

Inserts sections to complete validation of a form

ValidateItem

Object.ValidateItem ([error])

ierror – optional variable used to return an error code if one occurs.

Must be called for each element that needs to be validated.

EVENT RESPONSE

Response to events may be initiated by webface elements. However, the detail of the response need to be completed by the web programmer. A client-side javascript command or set of commands separated by the javascript limiter ";", or the name of a function may be supplied as the response to an element’s event. This is supplied using the EventResponse property. The default event to which each element responds is presented in the table below:

GUI Element	Events Responded To
Background	On change of input
Button, ButtonQ	On click of any button
CheckBox, CheckBoxQ	On check of any box
Color	On change of input
Date	On change of day, month, or year
Dimension, Dimensions	On change of input
DropDown	On change of selection
DropDownQ, DropDownQA, DropDownQE	On change of selection
EditArea, Editbox, Richtext
Email	On change of input
File, FilePath	On change of input
FolderPath	On change of input
Font	On change of selection
FontSize	On change of selection
FontStyle	On change of selection
HAlign	On change of selection
Image, IconFile	Same as FilePath
ImageBtn	Same as Image
Input	On change of input
Listbox	On change of selection
ListboxM	On change of selection
ListboxQ, ListboxQA, ListBoxQE	On change of selection
ListboxMQ, ListboxMQA, ListBoxMQA	On change of selection
Month	On change of month selected
MonthYear	On change of month selected or year entered
Password	On change of input
PasswordP	On change of input
Role, RoleE	On change of input
Size	On change of input
TextArea, Memo
Time	On change of hour or minute
UploadFile, UploadUnique	On Change of inputbox content
UploadPick, UploadPickUnique	On Change of inputbox content
UploadOnly, UploadOnlyUnique
URL	On change of input
User, Users	On change of input
UserType, UserTypeA	On change of selection
VAlign	On change of selection
Week, FullWeek	On change of selection
Year	On change of input

ADDITIONAL NOTES ON SPECIFIC ELEMENTS

Date

Draws three controls to receive a date input – a two-character textbox for the day, a dropdown for the month and a four-character textbox for the year. Appends the string "day", "month", and "year" respectively to the field name of the control in the presentation.

MonthYear

Draws two controls to receive a month and year input –a dropdown for the month and a four-character textbox for the year. Appends the string "month", and "year" respectively to the field name of the control in the presentation.

EditArea, TextArea, Richtext

These use an additional property – MaxCharacters - not used by the other elements. The value provided in MaxCharacters represent the limit of the characters that can be submitted in the box. Defaults to 4000 characters. The type of the richtext control can be determined using the OptionValues property. Acceptable types are article, content, corporate, email, guestbook, messageboard, and minimal

Font

Draws a drop-down selection box to allow a user select a font from NetVIOS’s font list. The list of font to be available is loaded when the OS is launched from the file _font.txt in the /WOS folder.

Time

Draws two drop-down boxes to receive an hour and a minute. Appends the string "hour", and "minute" respectively to the field name of the control in the presentation.

UploadFile, UploadPick, UploadUnique, UploadPickUnique, UploadOnly, UploadOnlyUnique

The folder to upload to can be set using the OptionValues property. A restriction on file types allowed can be set using the OptionList property. If the OptionList property is not provided, the default folder to upload to is used (set with the Application ("GeneralUploadFolder") variable) and all acceptable file types are accepted. Options for file types include – image, media, text, html, excel, doc, pdf, and office. If no restriction is provided all the above file types are accepted (but not executables or script files). To actually allow uploading any file type, the value of OptionList must be set to "anytype". See the Upload component manual for more details, if necessary.

NETVIOS WEBFACE FEATURES

General Syntax

The general syntax for invoking the NetVIOS element, using ASP scripting is shown below:

Set objfeature = Server.CreateObject("ubvios.features")

where objfeature is an name to be assigned to a feture object

To set a property

objfeature.Property = somevalue

To invoke an action

objfeature.Action argument1, argument2, …

Feature Properties

Name
Caption
Category
Default
FeatureList
FeatureType
OrderNumber
IsCookie
Scope
ScopeID
ScopeName
Value

Feature Actions

Processfeature

Description of the properties and actions

A description of each property and action is contained in this section. The mandatory properties are displayed in boldface.

Name
Name of the feature. Must be unique by scope.

Caption
The label to be used for the feature when querying the user for its value.

Category
An optional category name to be used to group features when querying the user for their values.

Default
Default value to be assigned to the feature before it is set by the user.

FeatureList
Comma-separated list to be used to supply list of values for dropdown boxes or buttons. May also take an SQL query syntax. Consult the property requirements for NetVIOS GUI Controls when using non common FeatureTypes.

FeatureType
A NetVIOS Webface GUI type (such as Input, Dropdown, Button, etc.)

IsCookie
This property takes on values of either True or False. Properties that are cookies can only be set by users since they are stored on client computers. Non-cookie properties appear the same way on all computers accessing the web page.

OrderNumber
Determines the ordering of the features when they are presented to the user to be set. The default is the order in which the features are created.

Scope
The value of scope may be Site, Application, or Page. For features with application scope, the name of the application must be provided with the ScopeName property.

ScopeName
Identify for the scope. Required only for features with application scope.

Value
Value of the feature. The value property is only set after the Processfeature action is called.

ProcessFeature

This action sets the value of the feature and stores the value in the Value property. The action takes no argument.

Home