Products
Support
Downloads
Purchase
Company
Subscriptions
Search: 
Available in: IP*WORKS! | SSH | SSL
Webform Class
WebForm Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

The WebForm component is used to POST data to interactive web pages or scripts (CGI, ASP, etc..), similar to what HTML forms do.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The inputs to the script are provided through the FormVars properties . Once the inputs are defined, set the URL property to the address of the script and call the Submit method. Alternatively, you may call the SubmitTo method with URL as the parameter.

The output of the page or script is provided via the Transfer event.

The Encoding property allows you to specify the proper encoding for the form input (this is normally 'urlencoding').

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

Accept A list of acceptable MIME types for the request.
AuthScheme The authorization scheme to be used when server authorization is to be performed.
Connected Shows whether the component is connected.
ContentType Content type for posts and puts.
Cookies Collection of cookies.
Encoding The encoding type for the form data.
Firewall A set of properties related to firewall access.
FollowRedirects Determines what happens when the server issues a redirect.
FormVars Form variables for the current request.
From The email address of the HTTP agent (optional).
Idle The current status of the component.
LocalFile The path to a local file for downloading. If the file exists, it is overwritten.
LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeaders Other headers as determined by the user (optional).
ParsedHeaders Collection of headers returned from the last request.
Password A password if authentication is to be used.
Proxy A set of properties related to proxy access.
Referer Referer URL/document (optional).
StatusLine The first line of the last server response.
Timeout A timeout for the component.
TransferredData The contents of the last response from the server.
TransferredDataLimit The maximum of data to be transferred.
TransferredHeaders The full set of headers as received from the server.
URL The URL to post information to.
User A user name if authentication is to be used.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

AddCookie Adds a cookie and the corresponding value to the outgoing request headers.
AddFormVar Adds a form variable and the corresponding value.
Config Sets or retrieves a component configuration setting.
DoEvents Processes events from the internal message queue.
Interrupt Interrupt the current method.
Reset Reset the component
Submit Post current data to the URL specified by the URL property.
SubmitTo Post current data to the URL specified by the 'URL' parameter.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Connected Fired immediately after a connection completes (or fails).
ConnectionStatus Fired to indicate changes in connection state.
Disconnected Fired when a connection is closed.
EndTransfer Fired when a document finishes transferring.
Error Information about errors during data delivery.
Header Fired every time a header line comes in.
Redirect Fired when a redirection is received from the server.
SetCookie Fired for every cookie set by the server.
StartTransfer Fired when a document starts transferring (after the headers).
Status Fired when the HTTP status line is received from the server.
Transfer Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptEncoding Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression This property enables HTTP compression for receiving data.
Authorization The Authorization string to be sent to the server.
CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
EncodeURL If set to true the URL will be encoded by the component.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
GetOn302Redirect If set to true the component will perform a GET on the new location.
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxHTTPCookies Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxHeaders Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthScheme The authorization scheme to be used for the proxy.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if authentication is to be used for the proxy.
TcpNoDelay Whether or not to delay when sending packets
TransferredDataLimit The maximum number of incoming bytes to be stored by the component.
UserAgent Information about the user agent (browser).

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.