Westwind.Web.Mvc

Base Controller implementation that holds UserState, ErrorDisplay objects that are preinitialized.

Contains User state information retrieved from the authentication system

ErrorDisplay control that holds page level error information

Override this method to create custom overridden userstate object instances.

Creates or updates a ViewModel and adds values to some of the stock properties of the Controller. This default implementation initializes the ErrorDisplay and UserState objects after creation.

Updates a ViewModel and adds values to some of the stock properties of the Controller. This default implementation initializes the ErrorDisplay and UserState objects after creation.

Allow external initialization of this controller by explicitly passing in a request context

Displays a self contained error page without redirecting. Depends on ErrorController.ShowError() to exist

Returns a Json error response to the client

Message of the error to return Optional status code.

Returns a JSON error response to the client

Exception that generates the error message and info to return Optional status code

Returns a content negotiated result based on the Accept header. Minimal implementation that works with JSON and XML content, can also optionally return a view with HTML.

// model data only public ActionResult GetCustomers() { return new NegotiatedResult(repo.Customers.OrderBy( c=> c.Company) ) } // optional view for HTML public ActionResult GetCustomers() { return new NegotiatedResult("List", repo.Customers.OrderBy( c=> c.Company) ) }

Data stored to be 'serialized'. Public so it's potentially accessible in filters.

Optional name of the HTML view to be rendered for HTML responses

Global static flag that allows you to set whether output is formatted. By default Debug settings of project are used - debug is formatted

Pass in data to serialize

Data to serialize

Pass in data and an optional view for HTML views

Extends Controller with Negotiated() ActionResult that does basic content negotiation based on the Accept header.

Return content-negotiated content of the data based on Accept header. Supports: application/json - using JSON.NET text/xml - Xml as XmlSerializer XML text/html - as text, or an optional View text/plain - as text

Data to return serialized data public ActionResult GetCustomers() { return this.Negotiated( repo.Customers.OrderBy( c=> c.Company) ) }

Return content-negotiated content of the data based on Accept header. Supports: application/json - using JSON.NET text/xml - Xml as XmlSerializer XML text/html - as text, or an optional View text/plain - as text

Name of the View to when Accept is text/html /// Data to return serialized data public ActionResult GetCustomers() { return this.Negotiated("List", repo.Customers.OrderBy( c=> c.Company) ) }

A generic Error Display class that can be used to display standalone error messages with a single line of code. Depends on a Error.cshtml view which is passed an ErrorViewModel as a parameter

Displays a generic error message

Displays a generic error message but allows passing a view model directly for additional flexibility

This method allows displaying an error page you specify and pass an optional ErrorViewModel as a parameter

Static method that can be called from outside of MVC requests (like in Application_Error) to display an error View.

Static method that can be called from outside of MVC requests (like in Application_Error) to display an error View.

Static method that can be called from outside of MVC requests (like in Application_Error) to display an error View.

Static method that can be called from outside of MVC requests (like in Application_Error) to display an error View.

Static method that can be called from outside of MVC requests (like in Application_Error) to display an error View.

Allows you to display an arbitrary view and pass an optional ErrorViewModel for it. In short it's a shortcut way to just execute a custom view.

Path to a ViewPage Optional ErrorViewModel to pass to the view

Works like JsonResult but uses Json.NET for serialization in MVC

Attribute that can be added to controller methods to force content to be GZip encoded if the client supports it

Override to compress the content that is generated by an action method.

Determines if GZip is supported

Sets up the current page or handler to use GZip through a Response.Filter IMPORTANT: You have to call this method before any output is generated!

An error display component that allows rich rendering of individual messages as well as validation error messages. Object should be passed in to view end rendered with <%= ((ErrorDisplay) ViewData["ErrorDisplay"]).Show(450,true) %> or via a view. Relies on several CSS Styles: .errordisplay, errordisplay-text, errordisplay-warning-icon, errordisplay-info-icon The icon links link to images.

The message that is displayed

Determines whether there is a message present.

Flag that determines whether the message is displayed as HTML or as text. By default message is encoded as text (true).

Timeout in milliseconds before the error display is hidden

Holds a modelstate errors collection

Method

Adds ModelState errors to the validationErrors

Adds an existing set of Validation Errors to the DisplayErrors

Adds an individual model error

The ID rendered into the page

Text for the control if applicable. This property may not apply to all types of controls

A value for the control for rendering. May not apply for all controls

The CSS class rendered

Any Html Attributes for the main element of this control specified as key value strings

A set of styles specified as key value strings

A style string you want to apply. Augmented by the Styles dictionary property

Internal output writer

Page level helper routines and state features for use internally in the control's code

renders standard attributes. Override for any custom attributes you want to add to the control. When overriding the base class method call the base method to include the stock rendering. Called by RenderAttributes.

Renders the attributes into the output stream

Returns rendered HTML output

Determines whether the control has already been rendered. Use to control whether scripts or other shared page components get rendered more than once.

Merges attributes from an object map

Simple Implemnetation of a Date Control that uses ui.jquery's Date picker control. Very rudimentary Requires: jquery.js and ui.jquery.js loaded (which includes date picker) expects ui. themes in folder below scripts

Application specific UrlHelper Extensions

Generic routine that embeds a control derived off base control into the current output stream. DateControl ErrorDisplay

Class that can be used by Controls to access some common high level functionality

Current Page State Instance

Embeds a piece of script into the page uniquely by id. Use this method to ensure this script block is loaded into the page only once based on a common id. First script loaded wins.

Internal Cached Page instance for access to client script

Returns a Url to a WebResource as a string

Any type in the same assembly as the Resource The full resource Id in the specified assembly

Embeds a script reference into the page

Embeds a script tag that references an external .js/resource

Application specific UrlHelper Extensions

Retrieves a CSS link based on a themes path

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to View could not be found..

Looks up a localized string similar to We are sorry, but an unspecified error occurred in the application. The error has been logged and forwarded to be checked out as soon as possible..

Allows for dynamically assigning the RequireSsl property at runtime either with an explicit boolean constant, a configuration setting, or a Reflection based 'delegate'

Default constructor forces SSL required

Allows assignment of the SSL status via parameter

Allows invoking a method at runtime to check for a value dynamically. Note: The method called must be a static method

Fully qualified type name on which the method to call exists Static method on this type to invoke with no parameters

Looks for an appSetting key you specify and if it exists and is set to true or 1 which forces SSL.

Set of generic MVC Html Helper utilities

Returns a selectListItem list for an enumerated value

Takes a dictionary of values and turns it into a SelectListItems enumeration. Converts the dictionary keys into the value and the dictionary value into the text.

Assumes the dictionary keys and values can be turned into strings using ToString()

Returns a select list of months of the year set with 01-12 and a custom format display string (01 - January by default)

Optional format string to format the month string. Based on a Date variable

Gets a select list of years.

Number of years to display Year to start. If 0 starts current year

Class that renders MVC views to a string using the standard MVC View Engine to render the view. Requires that ASP.NET HttpContext is present to work, but works outside of the context of MVC

Required Controller Context

Initializes the ViewRenderer with a Context.

If you are running within the context of an ASP.NET MVC request pass in the controller's context. Only leave out the context if no context is otherwise available.

Renders a full MVC view to a string. Will render with the full MVC View engine including running _ViewStart and merging into _Layout

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to render the view with String of the rendered view or null on error

Renders a full MVC view to a writer. Will render with the full MVC View engine including running _ViewStart and merging into _Layout

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to render the view with String of the rendered view or null on error

Renders a partial MVC view to string. Use this method to render a partial view that doesn't merge with _Layout and doesn't fire _ViewStart.

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer String of the rendered view or null on error

Renders a partial MVC view to given Writer. Use this method to render a partial view that doesn't merge with _Layout and doesn't fire _ViewStart.

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer Writer to render the view to

Renders a full MVC view to a writer. Will render with the full MVC View engine including running _ViewStart and merging into _Layout

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer Active Controller context String of the rendered view or null on error

Renders a full MVC view to a writer. Will render with the full MVC View engine including running _ViewStart and merging into _Layout

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer Writer to render the view to Active Controller context String of the rendered view or null on error

Renders a full MVC view to a writer. Will render with the full MVC View engine including running _ViewStart and merging into _Layout

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer Active Controller context optional out parameter that captures an error message instead of throwing String of the rendered view or null on error

Renders a full MVC view to a writer. Will render with the full MVC View engine including running _ViewStart and merging into _Layout

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer Active Controller context Writer to render the view to optional out parameter that captures an error message instead of throwing String of the rendered view or null on error

Renders a partial MVC view to string. Use this method to render a partial view that doesn't merge with _Layout and doesn't fire _ViewStart.

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer Active controller context String of the rendered view or null on error

Renders a partial MVC view to string. Use this method to render a partial view that doesn't merge with _Layout and doesn't fire _ViewStart.

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension The model to pass to the viewRenderer Active controller context Text writer to render view to optional output parameter to receive an error message on failure

Internal method that handles rendering of either partial or or full views.

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension Model to render the view with Determines whether to render a full or partial view Text writer to render view to

Internal method that handles rendering of either partial or or full views.

The path to the view to render. Either in same controller, shared by name or as fully qualified ~/ path including extension Model to render the view with Determines whether to render a full or partial view String of the rendered view

Creates an instance of an MVC controller from scratch when no existing ControllerContext is present

Type of the controller to create Controller for T thrown if HttpContext not available

Empty MVC Controller instance used to instantiate and provide a new ControllerContext for the ViewRenderer

Contains information about a paging setup

Client handler function called on POST operation with page number as parameter

Determines whether ExceptionDetail is allowed

When true returns standard ASP.NET yellow screen of death when DebugMode is enabled.