Class wwWebPage

The wwWebPage class is the top level container for a WebControl page. This container acts as the entry point for event processing and provides the HTML Document for page generation.

Custom
  wwWebControl
    wwWebPage

Class Members

MemberDescription

AddBindingError

Adds a binding error to the page's BindingErrors collection.

o.AddBindingError(lcMessage,lvControl)

AddValidationErrorsToBindingErrors

Allows you to a wwBusiness ValidationErrors collection and automatically add these errors to the BindingErrors Collection.

o.AddValidationErrorsToBindingErrors(loValidationErrors)

Authenticate

Allows you to check whether the current request is authenticated and if not prompt for authentication.

o.Authenticate(lcValidUserName,lcErrorMessage)

GetPostbackEventParameter

Returns the PostBack event parameter that might have been set by a postback event from the client.

o.GetPostbackEventParameter()

GetPostbackEventReference

Returns a client side Postback Event link (__doPostBack() call) that can be used to fire a server side event from client code.

o.GetPostbackEventReference(lcControlId,lcEvent,lcParameter,llIsLink)

OnError

Page level Error manager method. Return .T. to indicate that you have handled the error. Return .F. to indicate the error should bubble up to the Process class.

o.OnError(loException)

RegisterClientScriptBlock

Adds a client script block to the page. The block is added at the top of the page and typically used for adding functions.

o.wwWebPage.RegisterClientScriptBlock(lcID,lcScriptCode,lcLocation)

RegisterClientScriptInclude

Inserts a link to an external script file into the page. Generates <script src="scriptpage.js"></script> into the page.

o.wwWebPage.RegisterClientScriptInclude(lcID,lcScriptLink,lcLocation)

RegisterCssInclude

Inserts a stylesheet link into the page.

o.RegisterCssInclude(lcId,lcHref)

RegisterCursor

Adds a cursor to the list of open cursors that should be automatically closed when the page Dispose() fires.

o.RegisterCursor(lcCursorName)

RegisterPostbackScriptCode

This method is used to register the stock PostBackScript block in the page. This method should be called by any control that requires an Autopostback operation to be initiated.

o.RegisterPostbackScriptCode()

RegisterStartupScript

Embeds a script into that page that is added at the bottom of the page and allows executing 'startup' code.

o.wwWebPage.RegisterStartupScript(lcId,lcScript)

Render

Renders the Page by rendering the page and all of its contained components.

o.Render()

Run

This is a standalone routine that causes the page to process the Event pipeline and write output into the Response object. This method handles setup and cleanup plus error handling for the page.

o.Run()

SetFocus

Sets the focus to the control that is passed if possible.

o.SetFocus(loControl)

BindingErrors

Contains errors after UnbindData calls of the form.

ClientScript

The ClientScript collection holds all client scripts, script includes (<script> links) and code loaded CSS links. This property generally should not be manually accessed, but rather is manipulated through RegisterClientScriptBlock, RegisterClientScriptInclude and RegisterCssInclude.

EnableSessionState

Determines wheter sessions are used or not on this page. The default is off.

ErrorIconUrl

The URL to an image file that is used to display the error icon.

FormName

The name of the name of the form.

Header

The Page.Header controls is a simple container control that references the <head> tag of a page.

HiddenFormVars

Name Value Collection that allows adding of HiddenForm variables to the page.

IsWebPage

Marker Interface Property that lets you check for the control being a WebPage object.

jQueryConfig

Object that simplifies loading of jQuery, jQuery UI and ww.jquery.js programmatically into the page.

StartupScript

A collection of Script blocks that are rendered at the bottom of the Form. These scripts are automatically run when the page loads.

StopEventProcessing

Property that allows you to specify that no further page events should fire, but that rendering should still proceed.

SurpressHttpHeader

By default a standard Http Header is created, but you can set this property and write a standard Web Connection HTTP header on your own.


© West Wind Technologies, 1996-2018 • Updated: 03/19/14
Comment or report problem with topic