Export (0) Print
Expand All

AsyncController Class

.NET Framework 4

Provides the base class for asynchronous controllers.

Namespace:  System.Web.Mvc
Assembly:  System.Web.Mvc (in System.Web.Mvc.dll)

public ref class AsyncController abstract : public Controller, 
	IAsyncManagerContainer, IAsyncController, IController

The AsyncController type exposes the following members.

  NameDescription
Protected methodAsyncControllerInitializes a new instance of the AsyncController class.
Top

  NameDescription
Public propertyActionInvokerGets the action invoker for the controller. (Inherited from Controller.)
Public propertyAsyncManagerGets the asynchronous manager instance.
Protected propertyBindersGets or sets the binder. (Inherited from Controller.)
Public propertyControllerContextGets or sets the controller context. (Inherited from ControllerBase.)
Public propertyHttpContextGets HTTP-specific information about an individual HTTP request. (Inherited from Controller.)
Public propertyModelStateGets the model state dictionary object that contains the state of the model and of model-binding validation. (Inherited from Controller.)
Public propertyRequestGets the HttpRequestBase object for the current HTTP request. (Inherited from Controller.)
Public propertyResponseGets the HttpResponseBase object for the current HTTP response. (Inherited from Controller.)
Public propertyRouteDataGets the route data for the current request. (Inherited from Controller.)
Public propertyServerGets the HttpServerUtilityBase object that provides methods that are used during Web request processing. (Inherited from Controller.)
Public propertySessionGets the HttpSessionStateBase object for the current HTTP request. (Inherited from Controller.)
Public propertyTempDataGets or sets the dictionary for temporary data. (Inherited from ControllerBase.)
Public propertyTempDataProviderGets the temporary-data provider object that is used to store data for the next request. (Inherited from Controller.)
Public propertyUrlGets the URL helper object that is used to generate URLs by using routing. (Inherited from Controller.)
Public propertyUserGets the user security information for the current HTTP request. (Inherited from Controller.)
Public propertyValidateRequestGets or sets a value that indicates whether request validation is enabled for this request. (Inherited from ControllerBase.)
Public propertyValueProviderGets or sets the value provider for the controller. (Inherited from ControllerBase.)
Public propertyViewDataGets or sets the dictionary for view data. (Inherited from ControllerBase.)
Top

  NameDescription
Protected methodBeginExecuteCalled by ASP.NET to initialize asynchronous request processing.
Protected methodBeginExecuteCoreCalled by ASP.NET during initialization of asynchronous request processing.
Protected methodContent(String)Creates a content result object by using a string. (Inherited from Controller.)
Protected methodContent(String, String)Creates a content result object by using a string and the content type. (Inherited from Controller.)
Protected methodContent(String, String, Encoding)Creates a content result object by using a string, the content type, and content encoding. (Inherited from Controller.)
Protected methodCreateActionInvokerCreates an action invoker. (Overrides Controller::CreateActionInvoker().)
Protected methodCreateTempDataProviderCreates a temporary data provider. (Inherited from Controller.)
Public methodDispose()Releases all resources that are used by the current instance of the Controller class. (Inherited from Controller.)
Protected methodDispose(Boolean)Releases unmanaged resources and optionally releases managed resources. (Inherited from Controller.)
Protected methodEndExecuteCancels the execution of an asynchronous action method.
Protected methodEndExecuteCoreCalled by ASP.NET when the current asynchronous action has completed.
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodExecuteExecutes the specified request context. (Inherited from ControllerBase.)
Protected methodExecuteCoreInvokes the action in the current controller context. (Inherited from Controller.)
Protected methodFile(array<Byte>, String)Creates a FileContentResult object by using the file contents and file type. (Inherited from Controller.)
Protected methodFile(Stream, String)Creates a FileStreamResult object by using the Stream object and content type. (Inherited from Controller.)
Protected methodFile(String, String)Creates a FilePathResult object by using the file name and the content type. (Inherited from Controller.)
Protected methodFile(array<Byte>, String, String)Creates a FileContentResult object by using the file contents, content type, and the destination file name. (Inherited from Controller.)
Protected methodFile(Stream, String, String)Creates a FileStreamResult object using the Stream object, the content type, and the target file name. (Inherited from Controller.)
Protected methodFile(String, String, String)Creates a FilePathResult object by using the file name, the content type, and the file download name. (Inherited from Controller.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodHandleUnknownActionCalled when a request matches this controller, but no method with the specified action name is found in the controller. (Inherited from Controller.)
Protected methodInitializeInitializes data that might not be available when the constructor is called. (Inherited from Controller.)
Protected methodJavaScriptCreates a JavaScriptResult object. (Inherited from Controller.)
Protected methodJson(Object)Creates a JsonResult object that serializes the specified object to JavaScript Object Notation (JSON). (Inherited from Controller.)
Protected methodJson(Object, String)Creates a JsonResult object that serializes the specified object to JavaScript Object Notation (JSON) format. (Inherited from Controller.)
Protected methodJson(Object, JsonRequestBehavior)Creates a JsonResult object that serializes the specified object to JavaScript Object Notation (JSON) format using the specified JSON request behavior. (Inherited from Controller.)
Protected methodJson(Object, String, Encoding)Creates a JsonResult object that serializes the specified object to JavaScript Object Notation (JSON) format. (Inherited from Controller.)
Protected methodJson(Object, String, JsonRequestBehavior)Creates a JsonResult object that serializes the specified object to JavaScript Object Notation (JSON) format using the specified content type and JSON request behavior. (Inherited from Controller.)
Protected methodJson(Object, String, Encoding, JsonRequestBehavior)Creates a JsonResult object that serializes the specified object to JavaScript Object Notation (JSON) format using the content type, content encoding, and the JSON request behavior. (Inherited from Controller.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnActionExecutedCalled after the action method is invoked. (Inherited from Controller.)
Protected methodOnActionExecutingCalled before the action method is invoked. (Inherited from Controller.)
Protected methodOnAuthorizationCalled when authorization occurs. (Inherited from Controller.)
Protected methodOnExceptionCalled when an unhandled exception occurs in the action. (Inherited from Controller.)
Protected methodOnResultExecutedCalled after the action result that is returned by an action method is executed. (Inherited from Controller.)
Protected methodOnResultExecutingCalled before the action result that is returned by an action method is executed. (Inherited from Controller.)
Protected methodPartialView()Creates a PartialViewResult object that renders a partial view. (Inherited from Controller.)
Protected methodPartialView(Object)Creates a PartialViewResult object that renders a partial view, by using the specified model. (Inherited from Controller.)
Protected methodPartialView(String)Creates a PartialViewResult object that renders a partial view, by using the specified view name. (Inherited from Controller.)
Protected methodPartialView(String, Object)Creates a PartialViewResult object that renders a partial view, by using the specified view name and model. (Inherited from Controller.)
Protected methodRedirectCreates a RedirectResult object that redirects to the specified URL. (Inherited from Controller.)
Protected methodRedirectToAction(String)Redirects to the specified action using the action name. (Inherited from Controller.)
Protected methodRedirectToAction(String, Object)Redirects to the specified action using the action name and route values. (Inherited from Controller.)
Protected methodRedirectToAction(String, String)Redirects to the specified action using the action name and controller name. (Inherited from Controller.)
Protected methodRedirectToAction(String, RouteValueDictionary)Redirects to the specified action using the action name and route dictionary. (Inherited from Controller.)
Protected methodRedirectToAction(String, String, Object)Redirects to the specified action using the action name, controller name, and route values. (Inherited from Controller.)
Protected methodRedirectToAction(String, String, RouteValueDictionary)Redirects to the specified action using the action name, controller name, and route dictionary. (Inherited from Controller.)
Protected methodRedirectToRoute(Object)Redirects to the specified route using the specified route values. (Inherited from Controller.)
Protected methodRedirectToRoute(String)Redirects to the specified route using the route name. (Inherited from Controller.)
Protected methodRedirectToRoute(RouteValueDictionary)Redirects to the specified route using the route dictionary. (Inherited from Controller.)
Protected methodRedirectToRoute(String, Object)Redirects to the specified route using the route name and route values. (Inherited from Controller.)
Protected methodRedirectToRoute(String, RouteValueDictionary)Redirects to the specified route using the route name and route dictionary. (Inherited from Controller.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTryUpdateModel<TModel>(TModel)Updates the specified model instance using values from the controller's current value provider. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, String)Updates the specified model instance using values from the controller's current value provider and a prefix. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, array<String>)Updates the specified model instance using values from the controller's current value provider and included properties. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, IValueProvider)Updates the specified model instance using values from the value provider. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, String, array<String>)Updates the specified model instance using values from the controller's current value provider, a prefix, and included properties. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, String, IValueProvider)Updates the specified model instance using values from the value provider and a prefix. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, array<String>, IValueProvider)Updates the specified model instance using values from the value provider and a list of properties to include. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, String, array<String>, array<String>)Updates the specified model instance using values from the controller's current value provider, a prefix, a list of properties to exclude, and a list of properties to include. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, String, array<String>, IValueProvider)Updates the specified model instance using values from the value provider, a prefix, and included properties. (Inherited from Controller.)
Protected methodTryUpdateModel<TModel>(TModel, String, array<String>, array<String>, IValueProvider)Updates the specified model instance using values from the value provider, a prefix, a list of properties to exclude , and a list of properties to include. (Inherited from Controller.)
Protected methodTryValidateModel(Object)Validates the specified model instance. (Inherited from Controller.)
Protected methodTryValidateModel(Object, String)Validates the specified model instance using an HTML prefix. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel)Updates the specified model instance using values from the controller's current value provider. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, String)Updates the specified model instance using values from the controller's current value provider and a prefix. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, array<String>)Updates the specified model instance using values from the controller object's current value provider. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, IValueProvider)Updates the specified model instance using values from the value provider. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, String, array<String>)Updates the specified model instance using values from the controller's current value provider, a prefix, and included properties. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, String, IValueProvider)Updates the specified model instance using values from the value provider and a prefix. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, array<String>, IValueProvider)Updates the specified model instance using values from the value provider, a prefix, and a list of properties to include. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, String, array<String>, array<String>)Updates the specified model instance using values from the controller's current value provider, a prefix, a list of properties to exclude, and a list of properties to include. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, String, array<String>, IValueProvider)Updates the specified model instance using values from the value provider, a prefix, and a list of properties to include. (Inherited from Controller.)
Protected methodUpdateModel<TModel>(TModel, String, array<String>, array<String>, IValueProvider)Updates the specified model instance using values from the value provider, a prefix, a list of properties to exclude, and a list of properties to include. (Inherited from Controller.)
Protected methodValidateModel(Object)Validates the specified model instance. (Inherited from Controller.)
Protected methodValidateModel(Object, String)Validates the specified model instance using an HTML prefix. (Inherited from Controller.)
Protected methodView()Creates a ViewResult object that renders a view to the response. (Inherited from Controller.)
Protected methodView(Object)Creates a ViewResult object by using the model that renders a view to the response. (Inherited from Controller.)
Protected methodView(String)Creates a ViewResult object by using the view name that renders a view. (Inherited from Controller.)
Protected methodView(IView)Creates a ViewResult object that renders the specified IView object. (Inherited from Controller.)
Protected methodView(String, Object)Creates a ViewResult object by using the view name and model that renders a view to the response. (Inherited from Controller.)
Protected methodView(String, String)Creates a ViewResult object using the view name and master-page name that renders a view to the response. (Inherited from Controller.)
Protected methodView(IView, Object)Creates a ViewResult object that renders the specified IView object. (Inherited from Controller.)
Protected methodView(String, String, Object)Creates a ViewResult object using the view name, master-page name, and model that renders a view. (Inherited from Controller.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIActionFilter::OnActionExecutedThis API supports the MVC infrastructure and is not intended to be used directly from your code. This method calls the OnActionExecuted method. (Inherited from Controller.)
Explicit interface implemetationPrivate methodIActionFilter::OnActionExecutingThis API supports the MVC infrastructure and is not intended to be used directly from your code. This method calls the OnActionExecuting method. (Inherited from Controller.)
Explicit interface implemetationPrivate methodIAsyncController::BeginExecuteCalled by ASP.NET to begin the execution of an asynchronous action method.
Explicit interface implemetationPrivate methodIAsyncController::EndExecuteCancels the execution of an asynchronous action method by ASP.NET at the end of the execution of an asynchronous action method.
Explicit interface implemetationPrivate methodIAuthorizationFilter::OnAuthorizationThis API supports the MVC infrastructure and is not intended to be used directly from your code. This method calls the OnAuthorization method. (Inherited from Controller.)
Explicit interface implemetationPrivate methodIController::ExecuteExecutes the specified request context. (Inherited from ControllerBase.)
Explicit interface implemetationPrivate methodIExceptionFilter::OnExceptionThis API supports the MVC infrastructure and is not intended to be used directly from your code. This method calls the OnException method. (Inherited from Controller.)
Explicit interface implemetationPrivate methodIResultFilter::OnResultExecutedThis API supports the MVC infrastructure and is not intended to be used directly from your code. This method calls the OnResultExecuted method. (Inherited from Controller.)
Explicit interface implemetationPrivate methodIResultFilter::OnResultExecutingThis API supports the MVC infrastructure and is not intended to be used directly from your code. This method calls the OnResultExecuting method. (Inherited from Controller.)
Top

An asynchronous controller class name must end with "Controller". For example, a Product controller can be named ProductController but not Product or ProductCtrl.

Asynchronous controller action methods respond to requests that are sent to the controller. Asynchronous controller action methods must adhere to the following rules:

  • Asynchronous actions consist of a pair of action methods. The method that invokes the asynchronous process must have a name that ends with "Async". The method that is invoked when the process is finished (the completion method) must have a name that ends with ""Completed".

  • Action methods must be public.

  • Action methods cannot be static.

  • Action methods cannot have unbounded generic type parameters. An unbounded generic type parameter (also known as an open generic type) has an empty parameter list. For information about unbounded generic type parameters, see the section "Unbounded Type Parameters" in Constraints on Type Parameters (C# Programming Guide).

  • Action methods cannot be overloaded based on parameters. Action methods can be overloaded when they are disambiguated using attributes such as NonActionAttribute or HttpPostAttribute.

The following table lists the types that the completion action method for an asynchronous controller can return. The ActionAsync method can return any type, but the return type is ignored.

Return type

Control action return

void or null

The ControllerActionInvoker object returns an EmptyResult object.

ActionResult

The ControllerActionInvoker object calls the ExecuteResult method on the result.

Object (excluding ActionResult)

The result is passed to a CreateActionResult, method that creates a new ContentResult object. The Content method of the ContentResult object is set to the invariant string representation of the returned object.

A Visual Studio project with source code is available to accompany this topic: Download.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft