vgquotes/Lib/Portoa.Web.xml

470 lines
24 KiB
XML
Raw Normal View History

2011-02-10 04:39:59 +00:00
<?xml version="1.0"?>
<doc>
<assembly>
<name>Portoa.Web</name>
</assembly>
<members>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.Filters.OverrideStatusCodeFilter">
<summary>
If the result implements <see cref="T:Portoa.Web.Filters.IStatusOverridable"/>, then the HTTP status
code on the <c>Response</c> will be set according to the value of
<see cref="P:Portoa.Web.Filters.IStatusOverridable.StatusCode"/>
</summary>
</member>
2011-02-10 04:39:59 +00:00
<member name="T:Portoa.Web.Controllers.IErrorController">
<summary>
Signifies that this controller can handle errors that aren't handled by
application code
</summary>
</member>
<member name="M:Portoa.Web.Controllers.IErrorController.Unknown">
<summary>
Executed when an unknown error occurs
</summary>
</member>
<member name="M:Portoa.Web.Controllers.IErrorController.NotFound">
<summary>
Executed when a page is not found
</summary>
</member>
<member name="M:Portoa.Web.Controllers.IErrorController.Forbidden">
<summary>
Executed when the user is forbidden from seeing the requested page
</summary>
</member>
<member name="T:Portoa.Web.Models.ResolveWithServiceProviderModelBinder`1">
<summary>
Model binder that uses a service provider to resolve the model binder designated by
<typeparamref name="T"/> which will do the action model binding
</summary>
<typeparam name="T">The model binder to resolve</typeparam>
</member>
<member name="M:Portoa.Web.Util.HtmlHelperExtensions.Submit(System.Web.Mvc.HtmlHelper,System.String,System.String,System.Object)">
<summary>
Creates a submit button with the specified button text, input name and HTML attributes
</summary>
<param name="buttonText">The text to display on the submit button</param>
<param name="name">The name of the input</param>
<param name="htmlAttributes">Anonymous object with HTML attribute values</param>
</member>
<member name="M:Portoa.Web.Util.HtmlHelperExtensions.Label(System.Web.Mvc.HtmlHelper,System.String,System.String,System.Object)">
<summary>
Creates a label with the specified text for the specified reference tag
</summary>
<param name="labelText">The text/HTML to display inside the label</param>
<param name="htmlFor">The reference ID of the labeled node (e.g. the value of the "for" attribute)</param>
<param name="htmlAttributes">The HTML attributes</param>
</member>
<member name="M:Portoa.Web.Util.HtmlHelperExtensions.Button(System.Web.Mvc.HtmlHelper,System.String,System.Object)">
<summary>
Creates a button with the specified display text and the specified custom HTML attributes
</summary>
<param name="displayText">The text that the button will display</param>
<param name="htmlAttributes">Any additional HTML attributes for the input tag</param>
</member>
<member name="M:Portoa.Web.Util.HtmlHelperExtensions.Button(System.Web.Mvc.HtmlHelper,System.String,System.Web.Routing.RouteValueDictionary)">
<summary>
Creates a button with the specified display text and the specified custom HTML attributes
</summary>
<param name="displayText">The text that the button will display</param>
<param name="htmlAttributes">Any additional HTML attributes for the input tag</param>
</member>
<member name="T:Portoa.Web.Security.IAuthenticationService">
<summary>
Service for authenticating users
</summary>
</member>
<member name="M:Portoa.Web.Security.IAuthenticationService.Login(System.String)">
<summary>
Logs in the specified user with the specified username
</summary>
</member>
<member name="M:Portoa.Web.Security.IAuthenticationService.Logout">
<summary>
Logs out the currently logged in user
</summary>
</member>
<member name="M:Portoa.Web.Security.IAuthenticationService.IsValid(System.String,System.String)">
<summary>
Determines if a user identified by the given username and password
is a valid user in the system
</summary>
</member>
<member name="T:Portoa.Web.Models.EnumBinder`1">
<remarks>
Adapted from http://eliasbland.wordpress.com/2009/08/08/enumeration-model-binder-for-asp-net-mvc/
</remarks>
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.ErrorHandling.ErrorViewResult">
<summary>
Represents a view for when an error occurs
</summary>
</member>
<member name="T:Portoa.Web.Filters.IStatusOverridable">
<summary>
Enables action results to override the HTTP status code
</summary>
</member>
<member name="P:Portoa.Web.Filters.IStatusOverridable.StatusCode">
<summary>
Gets or sets the new HTTP status code for the result
</summary>
</member>
2011-02-10 04:39:59 +00:00
<member name="M:Portoa.Web.ErrorHandling.ErrorViewResult.ExecuteResult(System.Web.Mvc.ControllerContext)">
<summary>
Sets the HTTP status code on the response object before
calling base.ExecuteResult()
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="P:Portoa.Web.ErrorHandling.ErrorViewResult.Message">
<summary>
Gets or sets the error message
</summary>
</member>
<member name="P:Portoa.Web.ErrorHandling.ErrorViewResult.Error">
<summary>
Gets or sets the error that occurred
</summary>
</member>
<member name="P:Portoa.Web.ErrorHandling.ErrorViewResult.ModelCreator">
<summary>
Gets or sets the delegate to create the error model. By default it creates
an instance of <see cref="T:Portoa.Web.ErrorHandling.ErrorModel"/>.
</summary>
</member>
2011-02-10 04:39:59 +00:00
<member name="T:Portoa.Web.ErrorHandling.ApplicationErrorHandler">
<summary>
Handles global application-wide errors that don't get caught by
normal means
</summary>
</member>
<member name="M:Portoa.Web.ErrorHandling.ApplicationErrorHandler.HandleError(System.Exception,Portoa.Web.Controllers.IErrorController)">
<summary>
Handles global application errors by invoking the specified error controller
</summary>
</member>
<member name="T:Portoa.Web.Unity.ConfigureInterception">
<summary>
Configures interception to occur for any subsequent container registrations
that are not part of NHibernate
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.FilterInfoExtensions.Flatten(System.Web.Mvc.FilterInfo)">
<summary>
Flattens a <c>FilterInfo</c> object into a single <c>IEnumerable</c> containing
the <c>ActionFilter</c>, <c>ExceptionFilter</c>, <c>ResultFilter</c> and
<c>AuthorizationFilter</c> collections
</summary>
</member>
2011-02-10 04:39:59 +00:00
<member name="T:Portoa.Web.Util.NoTempDataProvider">
<summary> This class exists to get rid of the SessionState and TempData error. Just google it. </summary>
</member>
<member name="M:Portoa.Web.Util.NoTempDataProvider.SaveTempData(System.Web.Mvc.ControllerContext,System.Collections.Generic.IDictionary{System.String,System.Object})">
<summary> Don't use this method, it's only here to prevent you from using it. </summary>
</member>
<member name="M:Portoa.Web.Models.ModelBinderDictionaryExtensions.Add``2(System.Web.Mvc.ModelBinderDictionary)">
<summary>
Maps the type <typeparamref name="T"/> to the binder type <typeparamref name="TBinder"/>.
</summary>
</member>
<member name="M:Portoa.Web.Models.ModelBinderDictionaryExtensions.Add``2(System.Web.Mvc.ModelBinderDictionary,System.IServiceProvider)">
<summary>
Maps the type <typeparamref name="T"/> to the binder type <typeparamref name="TBinder"/>
using the given service provider to resolve the binder
</summary>
</member>
<member name="T:Portoa.Web.Unity.LogAllMethodCalls">
<summary>
Logs all interceptable method calls via the <see cref="T:Portoa.Web.Unity.LoggerCallHandler"/>
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.NeedsBuildUpAttribute">
<summary>
Indicates that an object needs to be built up by the container
</summary>
<see cref="T:Portoa.Web.InjectableFilterActionInvoker"/>
</member>
2011-02-10 21:05:53 +00:00
<member name="T:Portoa.Web.Unity.ILog4NetConfigurator">
<summary>
Exposes an interface to configure log4net
</summary>
</member>
<member name="M:Portoa.Web.Unity.ILog4NetConfigurator.SetName(System.String)">
<summary>
Sets the name of the logger to retrieve
</summary>
<param name="loggerName">Name of the logger to use</param>
</member>
<member name="M:Portoa.Web.Unity.ILog4NetConfigurator.UseXml(System.String)">
<summary>
Uses the <c>XmlConfigurator</c> to configure log4net
</summary>
<param name="filename">Optional filename to watch, otherwise it uses the default</param>
</member>
<member name="T:Portoa.Web.Unity.ConfigureLog4Net">
<summary>
Configures the application to use log4net
</summary>
</member>
2011-02-10 04:39:59 +00:00
<member name="T:Portoa.Web.Session.ISessionStore">
<summary>
Provides an interface for interacting with session data
</summary>
</member>
<member name="P:Portoa.Web.Session.ISessionStore.Item(System.String)">
<summary>
Gets or sets an item from the backing store
</summary>
<param name="key">The key of the item to retrieve</param>
2011-02-14 08:56:41 +00:00
<returns>The value stored in the specified key, or null if no such key exists</returns>
2011-02-10 04:39:59 +00:00
</member>
<member name="T:Portoa.Web.Unity.UnityContainerExtensions">
<summary>
Extension methods for <c>UnityContainer</c>
</summary>
</member>
<member name="M:Portoa.Web.Unity.UnityContainerExtensions.AddExtensionOnce``1(Microsoft.Practices.Unity.IUnityContainer)">
<summary>
Adds an extension if it hasn't already been registered with the container
</summary>
</member>
<member name="M:Portoa.Web.Unity.UnityContainerExtensions.AnyAreRegistered(Microsoft.Practices.Unity.IUnityContainer,System.Type[])">
<summary>
Determines whether any of the given types are registered in the container
</summary>
</member>
<member name="M:Portoa.Web.Unity.UnityContainerExtensions.AllAreRegistered(Microsoft.Practices.Unity.IUnityContainer,System.Type[])">
<summary>
Determines if all of the given types are registered in the container
</summary>
<param name="container"></param>
<param name="types"></param>
<returns></returns>
</member>
<member name="T:Portoa.Web.Session.HttpSessionStore">
<summary>
Session store that uses the current <c>HttpContext</c>
</summary>
</member>
<member name="T:Portoa.Web.Controllers.DefaultErrorController">
<summary>
Controller for handling and displaying errors that aren't handled by application code
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.Unity.UnitOfWorkCallHandler">
<summary>
Call handler that wraps a method call in a unit of work
</summary>
<seealso cref="T:Portoa.Persistence.UnitOfWorkAttribute"/>
<seealso cref="T:Portoa.Persistence.IUnitOfWork"/>
</member>
2011-02-10 04:39:59 +00:00
<member name="T:Portoa.Web.InjectableFilterActionInvoker">
<summary>
Enables you to dynamically add filters to a ControllerActionInvoker. This class will also
perform injection on all filters that are annotated with NeedsBuildUpAttribute.
</summary>
<remarks> Adapted from http://blog.ploeh.dk/2009/12/01/GlobalErrorHandlingInASPNETMVC.aspx </remarks>
</member>
<member name="M:Portoa.Web.InjectableFilterActionInvoker.GetFilters(System.Web.Mvc.ControllerContext,System.Web.Mvc.ActionDescriptor)">
<summary>
Overridden to add the new filters to the default filters
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.Unity.LoggerCallHandler">
<summary>
Performs automatic logging on method calls (but respects <see cref="T:Portoa.Logging.DoNotLogAttribute"/>)
</summary>
</member>
2011-02-10 04:39:59 +00:00
<member name="M:Portoa.Web.Unity.LoggerCallHandler.FormatString(System.String)">
<summary>
Truncates a string to 150 characters in a pretty way, if necessary
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.ErrorHandling.ErrorModel">
<summary>
Generic model for displaying errors
</summary>
</member>
<member name="P:Portoa.Web.ErrorHandling.ErrorModel.Exception">
<summary>
Gets or sets the exception that occurred
</summary>
</member>
2011-02-10 04:39:59 +00:00
<member name="M:Portoa.Web.Controllers.ControllerExtensions.ValidationErrorsToString(System.Web.Mvc.Controller)">
<summary>
Gets all model state errors as a line feed-delimited string
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.Controllers.ControllerExtensions.CreateJsonErrorResponse(System.Web.Mvc.Controller,System.String)">
<summary>
Creates a JSON response if an error occurred, appending all <c>ModelState</c> errors
to the response object
</summary>
<param name="errorMessage">The error message to display to the user</param>
<see cref="M:Portoa.Web.Controllers.ControllerExtensions.CreateJsonResponse(System.Web.Mvc.Controller,System.String,System.Collections.Generic.IDictionary{System.String,System.String})"/>
</member>
<member name="M:Portoa.Web.Controllers.ControllerExtensions.CreateJsonErrorResponse(System.Web.Mvc.Controller,System.Exception)">
<summary>
Creates a JSON response from an <c>Exception</c>
</summary>
<see cref="M:Portoa.Web.Controllers.ControllerExtensions.CreateJsonResponse(System.Web.Mvc.Controller,System.String,System.Collections.Generic.IDictionary{System.String,System.String})"/>
<seealso cref="M:Portoa.Web.Controllers.ControllerExtensions.CreateJsonErrorResponse(System.Web.Mvc.Controller,System.String)"/>
</member>
<member name="M:Portoa.Web.Controllers.ControllerExtensions.CreateJsonResponse(System.Web.Mvc.Controller,System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Creates a JSON response object
</summary>
<param name="errorMessage">The error message to display to the user</param>
<param name="data">Any data that needs to be passed to the client</param>
</member>
2011-02-10 04:39:59 +00:00
<member name="M:Portoa.Web.Controllers.ControllerExtensions.DoNotUseTempData(System.Web.Mvc.Controller)">
<summary>
Sets up the temporary data provider so that it won't barf with Session errors
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.Controllers.ControllerExtensions.RunInTransaction(System.Web.Mvc.IController,Portoa.Persistence.ITransactableService,System.Action)">
<summary>
Runs an action in a transaction. If an exception is thrown during execution, the transaction
will be <c cref="M:Portoa.Persistence.IUnitOfWork.Rollback">rolled back</c> and the exception will be raised.
</summary>
<param name="service">Service that can create a transaction</param>
<param name="action">The action to execute inside the transaction</param>
</member>
2011-02-10 04:39:59 +00:00
<member name="M:Portoa.Web.ControllerContextExtensions.GetFromRequest``1(System.Web.Mvc.ControllerContext,System.String)">
<summary>
Gets a value from the request and casts it to the specified type
</summary>
</member>
<member name="M:Portoa.Web.ControllerContextExtensions.GetFromRequest(System.Web.Mvc.ControllerContext,System.String)">
<summary>
Gets a value from the request
</summary>
</member>
<member name="M:Portoa.Web.ControllerContextExtensions.AddModelError(System.Web.Mvc.ControllerContext,System.String,System.String)">
<summary>
Adds an error to the model state
</summary>
</member>
<member name="T:Portoa.Web.ContainerControllerFactory">
<summary>
2011-02-14 08:56:41 +00:00
Uses an <c>IUnityContainer</c> to create controllers
2011-02-10 04:39:59 +00:00
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.Unity.ContainerResolvingServiceProvider">
2011-02-10 04:39:59 +00:00
<summary>
2011-02-14 08:56:41 +00:00
Service provider that uses an <c>IUnityContainer</c> to instantiate and locate services
2011-02-10 04:39:59 +00:00
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.Unity.CallHandlerExtensions.GetInstanceMethodInfo(Microsoft.Practices.Unity.InterceptionExtension.IMethodInvocation)">
<summary>
Gets the MethodInfo associated with the actual object instance
in a CallHandler's method invocation
</summary>
</member>
<member name="M:Portoa.Web.Unity.CallHandlerExtensions.GetParameters(Microsoft.Practices.Unity.InterceptionExtension.IParameterCollection)">
<summary>
LINQifies an annoying IParameterCollection
</summary>
</member>
<member name="T:Portoa.Web.Unity.ApplyUnityConfigurationSection">
<summary>
Reads the app config and applies the Unity configuration, if applicable
</summary>
</member>
<member name="T:Portoa.Web.IInjectableControllerFactory">
<summary>
<c cref="T:System.Web.Mvc.IControllerFactory">IControllerFactory</c> that provides a mechanism to perform injection
on the controller after it is instantiated
</summary>
</member>
<member name="E:Portoa.Web.IInjectableControllerFactory.OnControllerInstantiated">
<summary>
Event that fires after a controller is instantiated
</summary>
</member>
<member name="T:Portoa.Web.ServiceProviderControllerFactory">
<summary>
Controller factory that uses a service provider to resolve controllers
</summary>
</member>
<member name="M:Portoa.Web.HttpRequestBaseExtensions.Get``1(System.Web.HttpRequestBase,System.String)">
<summary>
Gets an object from the request variables, or its default value if
the key does not exist
</summary>
<typeparam name="T">The type to convert the value to</typeparam>
<param name="key">The request key of the object to retrieve</param>
</member>
<member name="T:Portoa.Web.MvcApplicationBase">
<summary>
Base for an MVC application using Unity/NHibernate
</summary>
</member>
<member name="F:Portoa.Web.MvcApplicationBase.Container">
<summary>
The container associated with this application
</summary>
</member>
<member name="M:Portoa.Web.MvcApplicationBase.HandleApplicationError(System.Exception)">
2011-02-10 04:39:59 +00:00
<summary>
Handles uncaught application exceptions; default implementation uses
<see cref="T:Portoa.Web.ErrorHandling.ApplicationErrorHandler"/> and <see cref="T:Portoa.Web.Controllers.DefaultErrorController"/> to
display errors
</summary>
<param name="exception">The uncaught exception</param>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.MvcApplicationBase.ConfigureModelBinders(System.Web.Mvc.ModelBinderDictionary)">
<summary>
Override to configure the model binders for the application; default implementation
does nothing
</summary>
</member>
<member name="M:Portoa.Web.MvcApplicationBase.CreateNHibernateConfiguration(Microsoft.Practices.Unity.IUnityContainer)">
2011-02-10 04:39:59 +00:00
<summary>
Creates the configuration used for NHibernate; default implementation uses the default
NHibernate configuration, and sets a custom interceptor. The configuration can be retrieved
outside of this method (if needed) via the container. Do not call this method directly.
</summary>
<seealso cref="T:Portoa.NHibernate.BuildWithProviderInterceptor"/>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.MvcApplicationBase.RegisterRoutes(System.Web.Routing.RouteCollection)">
2011-02-10 04:39:59 +00:00
<summary>
Registers any routes for the application; default implementation registers nothing
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.MvcApplicationBase.RegisterAreas">
2011-02-10 04:39:59 +00:00
<summary>
Registers any applicable areas; default implementations calls
<c>AreaRegistration.RegisterAllAreas()</c>
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.MvcApplicationBase.ConfigureControllerFactory">
2011-02-10 04:39:59 +00:00
<summary>
Configures the controller factory; default implementation uses Unity to
resolve each controller with a custom action invoker
</summary>
<see cref="T:Portoa.Web.InjectableFilterActionInvoker"/>
</member>
2011-02-14 08:56:41 +00:00
<member name="M:Portoa.Web.MvcApplicationBase.ConfigureUnity">
2011-02-10 04:39:59 +00:00
<summary>
Performs any application-specific configuration for Unity; default implementation
does nothing
</summary>
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.Models.FlagEnumModelBinder">
2011-02-10 04:39:59 +00:00
<summary>
2011-02-14 08:56:41 +00:00
Binds an enumeration annotated with the <c>FlagsAttribute</c>
2011-02-10 04:39:59 +00:00
</summary>
2011-02-14 08:56:41 +00:00
<remarks>
Adapted from http://blog.nathan-taylor.net/2010/06/aspnet-mvc-flags-enumeration-model.html
</remarks>
2011-02-10 04:39:59 +00:00
</member>
2011-02-14 08:56:41 +00:00
<member name="T:Portoa.Web.Results.StatusOverrideResult">
2011-02-10 04:39:59 +00:00
<summary>
2011-02-14 08:56:41 +00:00
<c>ActionResult</c> decorator that enables you to override the HTTP status code
2011-02-10 04:39:59 +00:00
</summary>
2011-02-14 08:56:41 +00:00
<see cref="T:Portoa.Web.Filters.OverrideStatusCodeFilter"/>
2011-02-10 04:39:59 +00:00
</member>
</members>
</doc>