External Interfaces > RealWeb > RealWeb API > Forms > Form Definition > RW_START_HTML_FORM

Comment on this topic

Documentation Comments

Use this form to comment on this topic. You can also provide any general observations about the Online Documentation, or request that additional information be added in a future release.

RealityV15.1Online Documentation (MoTW) Revision 7

RW_START_HTML_FORM (RealWeb) (rw_start_html_form.htm)

To

Reality

Version

Topic

Submitted by

Company

Location

Email address

Comment

 

 

RW_START_HTML_FORM


Purpose

Defines the start of an HTML form, with its ACTION attribute set to the URLClosed contained in ActionSub. Data from objects on the submitted form, such as edit boxes, can then be processed in ActionSub by making calls to RW_GET_PARAM for each of the objects.

Syntax

RW_START_HTML_FORM(ActionSub, Name, aClass)

Parameters

ActionSub The URLClosed of the subroutine to be run when the user clicks the form's Submit button.

Name The name of the form.

aClass A dynamic arrayClosed that can contain the following elements:

Element No. Attribute Description
1 CLASS The name of a tag class defined in a CSSClosed stylesheet.
2 TARGET Name of the target frame where the form is to be presented.
3 METHOD The method by which the browser will send the form's data to the server for processing. This attribute can be set to "GET" or "POST"; the default is "POST".
  • With the POST method, the browser sends the form's data in two steps: it first contacts the server specified in ActionSub and, once contact has been made, sends the data in a separate transmission.
  • The GET method contacts the server and sends the form's data in a single transmission: data is appended to the URLClosed in ActionSub, separated by a question mark.

In general, use POST if the form has many fields or has long text fields, or if security is an issue. Use GET for forms that have only a few short fields.

4 ENCTYPE

Specifies the encoding to be used to send the data back to the server. Can be optionally set to 'multipart/form-data' or 'text/plain'.

If you do not set this attribute, the standard encoding format is used..

You should specify 'text/plain' if the form is to be sent to an email address rather than to a server (the mailto URLClosed would be specified in ActionSub).

Attributes defined in the aClass parameter are applied to the FORM tag.

For information about using aClass, see The aClass Parameter

For further information on using forms, including encoding the data and the use of GET or POST, refer to the Recommended Reading section.

Dependencies

Requires a subsequent call to RW_END_FORM.

RealityV15.1 (MoTW) Revision 7Comment on this topic