Namespace Westwind.Web - West Wind Toolkit for .NET

Namespace Westwind.Web

This topic tree describes the Westwind.Web namespace.

Type	Description
ApplicationErrorModule	Application Error Module that can be used to handle errors. Uses WebErrorHandler to collect error and request information in a single place, and abstracts the error handling to OnLogError and OnDisplayError hooks to manage only the parts that we are typically interested in in error processing.
CallbackException	Special return type used to indicate that an exception was fired on the server. This object is JSON serialized and the client can check for Result.IsCallbackError to see if a a failure occured on the server.
CallbackHandler	CallbackHandler is an Http Handler base class that allows you to create a class with methods marked up with a [CallbackMethod] attribute which are then exposed for remote execution. The handler routes the to the methods and executes the call and returns the results - or any errors - as JSON strings. To use this service you need to create an HttpHandler (either .ASHX or a class registered in web.config's httpHandler section) and then add
CallbackHandlerRouteHandler	Route handler that can create instances of CallbackHandler derived callback classes. The route handler tracks the method name and creates an instance of the service in a predictable manner
CallbackMessage	Special return type that can be used to return messages to the caller directly rather than throwing an exception.
CallbackMethodAttribute	Marker Attribute to be used on Callback methods. Signals parser that the method is allowed to be executed remotely
ClientScriptProxy	This is a proxy object for the Page.ClientScript and MS Ajax ScriptManager object that can operate when MS Ajax when present otherwise falling back to Page.ClientScript. Because MS Ajax may not be available accessing the methods directly is not possible and we are required to indirectly reference client script methods through this class. This class should be invoked at the Control's start up and be used to replace all calls
CookieManager	A generic Cookie class that manages an individual Cookie by localizing the cookie management into a single class. This means the Cookie's name and and timing is abstracted. The GetId() method is the key method here which retrieves a Cookie Id. If the cookie exists it returns the value, otherwise it generates a new Id and creates the cookie with the specs of the class and It's recommended you store this class as a static member off another
ErrorViewModel
FormVariableBinder	The class that provides FormVariable to Model binding by matching FormVariable names to the model's properties including child properties. You can specify a The base behavior is similar to ASP.NET MVC's ModelBinder's binding operation minus the validation features.
JavaScriptMinifier	JavaScript minifier strips white space and comments from JavaScript code. Based on Douglas Crockford's JavaScript Minifier with some modification to support string and StreamReader conversions. This class can minify strings in memory or files and entire directories of disk files. The MinifyDirectory() method can be used in the build process for VS or can easily be used at application startup to automatically create minified script files
JsonCallbackMethodProcessor	This is the core implementation of the JSON callback method handler that picks up POST data from the request and uses it to call the actual callback method on the specified object and return the results back as JSON. This processor is generic and can be used easily from anywhere that needs to feed back JSON data from a method callback, simply calling the ProcessCallbackMethod() with an object that contains methods that are marked up with the
JsonVariables	JsonVariables provides an easy way to embed server side objects and values as JSON into client side JavaScript code. You can use the dynamic Add() method to add properties to an object with each added value becoming a property on the rendered JSON object. Pass simple values, or complex objects and lists to easily push server side static data into client side JavaScript code. The static ToJsonString() and ToJsonHtmlString() methods also
ResponseFilterStream	A semi-generic Stream implementation to use with Response.Filter. Uses an event based interface for handling Content capture and transformations with several variations of events that can capture the entire output and transform it or work on actual Response Write() chunks individually. The key operational interface to this class is via exposed via Events More information on how this class works:
ScriptCompressionModule	Module that handles compression of JavaScript resources using GZip and script optimization that strips comments and extra whitespace. This module should be used in conjunction with ClientScriptProxy.RegisterClientScriptResource which sets up the proper URL formatting required for this module to handle requests. Format is: wwSc.axd?r=ResourceName&t=FullAssemblyName The type parameter can be omitted if the resource lives in this
ScriptLoader	that handles embedding of common script files like jQuery into a page or return complete script tags for insertion into a ViewPage as a string.
ScriptResourceAlias
StaticCookieManager	A generic Web Cookie handler class that can be used for a single 'UserId' in an application. This class manages all aspects of retrieving and setting of a cookie consistently. Typically all you'll need to do is call the GetId() method which both returns existing cookies and ensures that the cookie gets set. All methods of this class are static which is the reason why only a single Cookie can be managed at a time. The idea is that you can use
UserState	User information container that can easily 'serialize' to a string and back. Meant to hold basic logon information to avoid trips to the database for common information required by an app to validate and display user info. I use this class a lot to attach as Forms Authentication Ticket data to keep basic user data without having to hit the database
WebErrorHandler	that can be used to parse ASP.NET and exception error information into an object. This class is ideal for capturing information for logging, notification and display of detailed error information. Also supports complete Application_Error handling with the HandleError method which works off an exception and provides a complete handler for processing error information with hooks for logging and displaying of an error page.
WebResources	is used as to consolidate access to resources
XmlCallbackMethodProcessor	This is the core implementation of the JSON callback method handler that picks up POST data from the request and uses it to call the actual callback method on the specified object and return the results back as JSON. This processor is generic and can be used easily from anywhere that needs to feed back JSON data from a method callback, simply calling the ProcessCallbackMethod() with an object that contains methods that are marked up with the
CallbackMethodParameterType
ErrorHandlingModes
HttpVerbs
JavaScriptCodeLocationTypes
jQueryLoadModes	The location from which jQuery and jQuery UI are loaded in Release mode.
PostBackModes
ProxyClassGenerationModes
ScriptRenderModes	Determines how scripts are included into the page
AllowUpdateTypes
ICallbackMethodProcessor	Inteface that defines the Callback operations for handling method callbacks on the server. This interface serves as an abstraction for potentially different implementations that use XML instead of JSON.