Web Form Objects Component
Introduction
User Guide
Object Model
Technical ReferenceDownload
Buy a License
Other Volto Components
|
| Objects | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
WFO This object provides methods and properties to create forms as FormObject objects. The following table describes the object's methods:
The following table describes the object's properties:
FormObjects This is a collection of FormObject objects representing Forms. The following table describes the object's methods:
FormObject This object represents a Form and provides methods and properties to add items to the Form as FormItem objects and to submit the form. Multiple FormObject objects can be created in the FormObjects collection of the WFO object. The following table describes the object's methods:
The following table describes the object's properties:
FormItems This is a collection of FormItem objects representing items on a Form. The following table describes the object's methods:
FormItem This object represents an item on a Form. Multiple FormItem objects can be created in the FormItems collection of a FormObject object. The following table describes the object's properties:
|
| Methods | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Add Adds an object to a collection. Syntax object.Add obj The Add method has the following parts:
Count Returns the number of objects in a collection. Syntax object.Count The Count method has the following parts:
CreateForm Creates and returns a new FormObject object. Each object consists of an ID, a URL and an HTTP method. Syntax object.CreateForm (ID, Method, URL) The CreateForm method has the following parts:
Remarks When submitting a form with the POST method, the data will be sent as URL-encoded form data. When submitting as form with the GET method, the form data will be included as a query string following the URL. CreateItem Creates and returns a new FormItem object. Each object consists of an ID and Value. Syntax object.CreateItem (ID, Value) The CreateItem method has the following parts:
Item Returns a specific member of a collection either by position or by key. Either a FormObject or FormItem object is returned. Syntax object.Item (Index) The Item method has the following parts:
Remarks If the value provided as Index doesn’t match any existing member of the collection, an error occurs. The Item method is the default method for a collection. Therefore, the following lines of code are equivalent:
Print objWFO.FormObjects(1).ID
Print objWFO.FormObjects.Item(1).ID
ProductLicense Unlocks full component functionality when a valid Serial Number and License Key pair is given. The Serial Number and License Key, together with a license file, are provided when purchasing a license for this component. Returns a boolean value - true if a valid Serial Number and License Key were entered, or false otherwise. Syntax object.ProductLicense (SerialNo, LicenseKey) The ProductLicense method has the following parts:
Remarks Call this method once only, immediately after creating the object, in order to unlock full component functionality. If you do not make a successful call to this method, then only restricted, evaluation mode functionality will be available. Note that the license file provided to licensed users must be present in the same directory as that in which the component has been installed. This file must also be distributed with compiled applications and copied to the appropriate directory by the application's setup utility. ProxySettings Configures the settings for connections via an HTTP Proxy Server. Syntax object.ProxySettings ProxyServer, ProxyPort [,ProxyUserName] [,ProxyPassword] The ProxySettings method has the following parts:
Remove Removes a specific member of a collection. Syntax object.Remove Index The Remove method has the following parts:
Submit Submits a form. Syntax object.Submit The Submit method has the following parts:
|
| Properties | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HTTPStatus Returns the HTTP status code and text returned by the web server following a form submission using the Submit method. Syntax object.HTTPStatus The HTTPStatus property has the following parts:
ID Sets or returns the ID of a FormObject or FormItem object. Syntax object.ID [= strID] The Timeout property has the following parts:
Method Sets or returns the HTTP method by which a form represented by a FormObject is to be submitted. Syntax object.ID [= method] The Method property has the following parts:
ProductVersion Returns the version of the component. This is a string in the format "MM.mm.RR" where MM is the major version number, mm is the minor version number and RR is the revision number. e.g: "02.00.01". Syntax object.ProductVersion The ProductVersion property has the following parts:
Response Returns the body of the HTTP data returned by the web server following a form submission using the Submit method. Syntax object.Response The Response property has the following parts:
Timeout Sets the timeout (in seconds) for form submissions using the Submit method. If no response is received from the server within the timeout period, an ERR_TIMEOUT error is raised. Syntax object.Timeout [= wfoTimeout] The Timeout property has the following parts:
URL Sets or returns the URL to which the form represented by a FormItem object will be submitted when calling the Submit method. Syntax object.URL [= strURL] The URL property has the following parts:
UserAgent Sets the User Agent identification in HTTP headers sent when submitting forms. Syntax object.UserAgent [= wfoUserAgent] The UserAgent property has the following parts:
Note: Some HTTP Proxy Servers restrict access to certain browser types only and identify the calling browser by checking the contents of the HTTP User-Agent header. This property provides a way of making HTTP calls from the component look as though they are coming from a standard browser. By default, the component sends the following User-Agent header: Mozilla/4.0 (compatible; MSIE 5.0; Windows NT) Value Sets or returns the value of a form item represented by a FormItem object. Syntax object.Value [= strValue] The Value property has the following parts:
|
| Errors | ||||||||||||||||||||||||
Various errors may be raised when creating or submitting forms. Error constants
are available as WFOErrorConstants and valid values are:
|
© Copyright 2005 VOLTO.COM