Class Html3() Professional

Class function of the Html3 class.

Description

An HTML3 object is used to retrieve information entered in a Web browser and to send HTML formatted strings from a package DLL back to a Web browser. An HTML3 object is passed as the first parameter to a registered form-function. Example:

FUNCTION _Register( oPackage ) 
   oPackage:registerForm( "UserForm" ) 
RETURN 

FUNCTION UserForm( oHTML3, oContext ) 
   <...> 
RETURN .T. 

Most of the methods of the HTML3 object accept as parameters character strings used to create HTML formatted strings.

Any HTML page can be assembled using three generic methods. The begin and the end of an HTML page is marked by the methods :header() and :footer(). Calling other methods in between :header() and :footer() defines the contents of the HTML page that is returned to the Web browser.

Generic
:message()
Create a HTML page with a notification.
:setLocation()
Redirect a request to a different URL.
:header()
Mark the beginning of the HTML page. Web browser.
:put()
Add HTML code.
:footer()
Mark the end of the HTML page.
Html form variables
:getAllVars()
Get all name value pairs from an HTML form request.
:getFile()
![B:0355] Get the content of a file that was uploaded to the WAA server.
:getVar()
Get the values of a HTML form variable.
:setVar()
Define a hidden variable in the HTML page.
File transfer
:putData()
Write a file on the HTTP server machine.
:putFile()
Copy a file from the WAA server machine to the HTTP server machine.
:img()
Create HTML code for an image.
Html form
:formStart()
Mark the begin of an HTML form.
:formEnd()
Create the epilog of an HTML form.
:resetButton()
Creat HTML code for a resetbutton.
:submitButton()
Create a submit button.
Html Input controls
:checkBox()
Create HTML code for a checkbox.
:radioButton()
Create HTML code for a radiobutton.
:ref()
Create HTML code for a hyperlink.
:selectStart()
Mark the begin of a selection.
:selectOption()
Create HTML code for an option.
:selectEnd()
Mark the end of a selection.
:SLE()
Create HTML code for a single line entry field.
:MLE()
Create HTML code for a multi-line entry field.
Cookies
:getCookie()
Get the cookies sent from the Web browser.
:setCookie()
Set a cookie.
:resetCookie()
Invalidate all cookies set.
Error Handling
:cgiError()
Error handling on uncomplete CGI requests.
:dllError()
Error handling on unavailable packages or form functions.
:prgError()
Error handling for runtime errors on PRG code level.
Browse view
:browseHeader()
Create the title of a browse view.
:browseRow()
Create the row of a browse view.
:browseFooter()
Mark the end of a browse view.
Remote Edit view
:editHeader()
Create the header of a remote edit view.
:editField()
Create an input control for the remote edit view.
:editComment()
Create informational text.
:editFooter()
Mark the end of a remote edit view.
Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.