Class wwPageResponse

The wwPageResponse class provides the output object that Web Connection code writes output into. This class provides raw output via Response.Write() as well as header management. This class operates in memory and all user code interacts with this class in some way to generate its HTTP output for the client.

The wwPageResponse object is new in Web Connection 5.0 and replaces the wwResponse set of classes that the user interacts with. This new class encapsulates both response output as well as HTTP headers in a fully cached manner so headers can be added to requests at any point in time.

The class's Render() method is used to retrieve the entire HTTP output including headers for this request. wwPageResponse is not at this time the default Response object so you have to explicitly specify it in any wwProcess subclasses with:

cResponseClass = "wwPageRepsonse"

Backwards Compatibility
For legacy purposes and compatibility with Web Connection 4.x and older there's a wwPageResponse40 class that implements all of the dropped wwResponse methods. You can reference this class easily in your wwProcess class.
cResponseClass = "wwPageRepsonse40"
This class should allow existing applictions to use the new Page class functionality without any major changes.



Class Members

MemberDescription
AddCacheHeader Adds an HTTP header that provides for Maximum Caching Capabilities
o.AddCacheHeader(lnExpirationSeconds)
AddCookie Adds a cookie to the current Response.
o.AddCookie(tcCookie,tcValue,tcPath,tcExpire)
AddForceReload Adds maximum Cache Expiration headers to the current HTTP request. Essentially this forces the request to always be reloaded rather than cached.
o.AddForceReload()
AppendHeader Adds an HTTP Header to the current page.
o.AppendHeader(lcHeaderKey,lcHeaderValue)
BasicAuthentication This method creates a self contained HTTP request that asks the browser to
present the login dialog into which the user must type the username and
password. The password is then validated by the Web server typically
against the NT (or Windows) user database. The exact validation varies by
Web server - IIS uses the NT User database on the server.
o.BasicAuthentication(tcRealm, tcErrorText)
BinaryWrite Same as Write() but provided for ASP.NET compatibility.
o.BinaryWrite(lcText)
Clear Clears the content of the current Response output.
o.Clear()
DownloadFile Downloads a file directly from disk to the client using a FileOpen dialog.
o.DownloadFile(lcFileName, lcContentType, lcFileDisplayName)
End Ends the current response. Any further output send to the Response object is ignored.
o.End()
ExpandPage Executes a Web Control Framework page by providing a physical path to the page allowing for parsing, compiling and running the page.
o.ExpandPage(lcPhysicalPath, lnPageParseMode)
ExpandScript The ExpandScript method method is used to expand script pages that contain FoxPro expressions and Code blocks using Active Server like syntax. The method generates a fully self contained HTML page/HTTP output which includes an HTTP header.
o.ExpandScript(tcPageName, tnMode, tvContentType, tlTemplateStr, llNoOutput)
ExpandTemplate The ExpandTemplate method is used to expand template pages that contain FoxPro expressions using Active Server like syntax. The method generates a fully self contained HTML page/HTTP output which includes an HTTP header.
o.ExpandTemplate(tcPageName, tcContentType, tlTemplateString, tlNoOutput)
FastWrite Direct write to the output stream. This method directly writes into the response stream and bypasses any checks and flags. So it doesn't check for the ResponseEnded flag for example.
o.FastWrite(lcText)
HTMLFooter Creates a footer for a page. Creates </BODY></HTML> tags preceeded by
option HTML passed as parm. Optionally pass text to display just prior to
tags
o.HTMLFooter(tcText,tlNoOutPut)
Redirect HTTP Redirection allows you redirect the current request to another URL. A common scenario is for login operations where the user is trying to access functionality before he's logged in. When the request comes in you can redirect the user to the Login page first.
o.Redirect(lcUrl,llPermanent)
Render This method is called to return the output of the Response object. It combines the headers and the body together and returns the entire response.
o.Render()
TransmitFile This method allows you send large files to the client without having to use Response.Write() to load these files into a string in Visual FoxPro.
o.TransmitFile(lcFileName, lcContentType)
Write Raw HTTP output function. Writes directly to the Response stream/string.
o.Write(lcText)
ContentType Sets the content type for the current HTTP response. This value defaults to text/html if not set.
Cookies Cookies collection that contains multiple cookies that are set for the current request. The cookies are written at the end when the headers are created and written.
Encoding Sets the content encoding for the page for text content.
Expires The number of minutes before the page is expired.
GZipCompression If set to .T. automatically encodes the Response output to GZip compressed format. When set Web Connection automatically checks whether the client supports GZip compression and only compresses content if it does.
Headers A collection of individual HTTP headers that are to be added to the request header. The Headers of the Response can be set at any time during the request as they are cached and written at the end of the request.
RawHeaders This is the low level string that is used to hold any RAW headers you want to add to a request. This is an override to Headers.Add() to allow for any headers or content that doesn't follow the name/value syntax of headers.
ResponseEnded Set to turn off output that follows called by the Write method. This flag is set by Response.End() so you usually should not have to set this explicitly. However, you can use it to check whether the Response object is active.
Status Allows you to specify the Response Status Code. The status code is the status number and message that follows the HTTP protocol.

Requirements

Assembly: wwPageResponse.prg


  Last Updated: 12/28/2008 | © West Wind Technologies, 2008