Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ControllerBase Class
Definition
- Namespace:
- Microsoft.AspNetCore.Mvc
- Assembly:
- Microsoft.AspNetCore.Mvc.Core.dll
- Package:
- Microsoft.AspNetCore.Mvc.Core v1.0.0
- Package:
- Microsoft.AspNetCore.Mvc.Core v1.1.0
- Package:
- Microsoft.AspNetCore.App.Ref v10.0.0
- Package:
- Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
- Package:
- Microsoft.AspNetCore.Mvc.Core v2.0.0
- Package:
- Microsoft.AspNetCore.Mvc.Core v2.1.0
- Package:
- Microsoft.AspNetCore.Mvc.Core v2.2.0
- Package:
- Microsoft.AspNetCore.App.Ref v3.0.1
- Package:
- Microsoft.AspNetCore.App.Ref v3.1.10
- Package:
- Microsoft.AspNetCore.App.Ref v5.0.0
- Package:
- Microsoft.AspNetCore.App.Ref v6.0.36
- Package:
- Microsoft.AspNetCore.App.Ref v7.0.5
- Package:
- Microsoft.AspNetCore.App.Ref v8.0.19
- Package:
- Microsoft.AspNetCore.App.Ref v9.0.8
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
- Source:
- ControllerBase.cs
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A base class for an MVC controller without view support.
public ref class ControllerBase abstract
[Microsoft.AspNetCore.Mvc.Controller]
public abstract class ControllerBase
[<Microsoft.AspNetCore.Mvc.Controller>]
type ControllerBase = class
Public MustInherit Class ControllerBase
- Inheritance
-
ControllerBase
- Derived
- Attributes
Constructors
| Name | Description |
|---|---|
| ControllerBase() | |
Properties
| Name | Description |
|---|---|
| ControllerContext |
Gets or sets the ControllerContext. |
| Empty |
Gets an instance of EmptyResult. |
| HttpContext |
Gets the HttpContext for the executing action. |
| MetadataProvider |
Gets or sets the IModelMetadataProvider. |
| ModelBinderFactory |
Gets or sets the IModelBinderFactory. |
| ModelState |
Gets the ModelStateDictionary that contains the state of the model and of model-binding validation. |
| ObjectValidator |
Gets or sets the IObjectModelValidator. |
| ProblemDetailsFactory |
Gets or sets the ProblemDetailsFactory. |
| Request |
Gets the HttpRequest for the executing action. |
| Response |
Gets the HttpResponse for the executing action. |
| RouteData |
Gets the RouteData for the executing action. |
| Url |
Gets or sets the IUrlHelper. |
| User |
Gets the ClaimsPrincipal for user associated with the executing action. |
Methods
| Name | Description |
|---|---|
| Accepted() |
Creates an AcceptedResult object that produces a Status202Accepted response. |
| Accepted(Object) |
Creates an AcceptedResult object that produces a Status202Accepted response. |
| Accepted(String, Object) |
Creates an AcceptedResult object that produces a Status202Accepted response. |
| Accepted(String) |
Creates an AcceptedResult object that produces a Status202Accepted response. |
| Accepted(Uri, Object) |
Creates an AcceptedResult object that produces a Status202Accepted response. |
| Accepted(Uri) |
Creates an AcceptedResult object that produces a Status202Accepted response. |
| AcceptedAtAction(String, Object, Object) |
Creates an AcceptedAtActionResult object that produces a Status202Accepted response. |
| AcceptedAtAction(String, Object) |
Creates an AcceptedAtActionResult object that produces a Status202Accepted response. |
| AcceptedAtAction(String, String, Object, Object) |
Creates an AcceptedAtActionResult object that produces a Status202Accepted response. |
| AcceptedAtAction(String, String, Object) |
Creates an AcceptedAtActionResult object that produces a Status202Accepted response. |
| AcceptedAtAction(String, String) |
Creates an AcceptedAtActionResult object that produces a Status202Accepted response. |
| AcceptedAtAction(String) |
Creates an AcceptedAtActionResult object that produces a Status202Accepted response. |
| AcceptedAtRoute(Object, Object) |
Creates an AcceptedAtRouteResult object that produces a Status202Accepted response. |
| AcceptedAtRoute(Object) |
Creates an AcceptedAtRouteResult object that produces a Status202Accepted response. |
| AcceptedAtRoute(String, Object, Object) |
Creates an AcceptedAtRouteResult object that produces a Status202Accepted response. |
| AcceptedAtRoute(String, Object) |
Creates an AcceptedAtRouteResult object that produces a Status202Accepted response. |
| AcceptedAtRoute(String) |
Creates an AcceptedAtRouteResult object that produces a Status202Accepted response. |
| BadRequest() |
Creates a BadRequestResult that produces a Status400BadRequest response. |
| BadRequest(ModelStateDictionary) |
Creates a BadRequestObjectResult that produces a Status400BadRequest response. |
| BadRequest(Object) |
Creates a BadRequestObjectResult that produces a Status400BadRequest response. |
| Challenge() |
Creates a ChallengeResult. |
| Challenge(AuthenticationProperties, String[]) |
Creates a ChallengeResult with the specified specified authentication schemes and
|
| Challenge(AuthenticationProperties, String[]) |
Creates a ChallengeResult with the specified authentication schemes and
|
| Challenge(AuthenticationProperties) |
Creates a ChallengeResult with the specified |
| Challenge(AuthenticationProperties) |
Creates a ChallengeResult with the specified |
| Challenge(String[]) |
Creates a ChallengeResult with the specified authentication schemes. |
| Conflict() |
Creates a ConflictResult that produces a Status409Conflict response. |
| Conflict(ModelStateDictionary) |
Creates a ConflictObjectResult that produces a Status409Conflict response. |
| Conflict(Object) |
Creates a ConflictObjectResult that produces a Status409Conflict response. |
| Content(String, MediaTypeHeaderValue) |
Creates a ContentResult object by specifying a
|
| Content(String, String, Encoding) |
Creates a ContentResult object by specifying a
|
| Content(String, String) |
Creates a ContentResult object by specifying a
|
| Content(String) |
Creates a ContentResult object by specifying a |
| Created() |
Creates a CreatedResult object that produces a Status201Created response. |
| Created(String, Object) |
Creates a CreatedResult object that produces a Status201Created response. |
| Created(Uri, Object) |
Creates a CreatedResult object that produces a Status201Created response. |
| CreatedAtAction(String, Object, Object) |
Creates a CreatedAtActionResult object that produces a Status201Created response. |
| CreatedAtAction(String, Object) |
Creates a CreatedAtActionResult object that produces a Status201Created response. |
| CreatedAtAction(String, String, Object, Object) |
Creates a CreatedAtActionResult object that produces a Status201Created response. |
| CreatedAtRoute(Object, Object) |
Creates a CreatedAtRouteResult object that produces a Status201Created response. |
| CreatedAtRoute(String, Object, Object) |
Creates a CreatedAtRouteResult object that produces a Status201Created response. |
| CreatedAtRoute(String, Object) |
Creates a CreatedAtRouteResult object that produces a Status201Created response. |
| File(Byte[], String, Boolean) |
Returns a file with the specified |
| File(Byte[], String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns a file with the specified |
| File(Byte[], String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns a file with the specified |
| File(Byte[], String, String, Boolean) |
Returns a file with the specified |
| File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns a file with the specified |
| File(Byte[], String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns a file with the specified |
| File(Byte[], String, String) |
Returns a file with the specified |
| File(Byte[], String) |
Returns a file with the specified |
| File(Stream, String, Boolean) |
Returns a file in the specified |
| File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns a file in the specified |
| File(Stream, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns a file in the specified |
| File(Stream, String, String, Boolean) |
Returns a file in the specified |
| File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns a file in the specified |
| File(Stream, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns a file in the specified |
| File(Stream, String, String) |
Returns a file in the specified |
| File(Stream, String) |
Returns a file in the specified |
| File(String, String, Boolean) |
Returns the file specified by |
| File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns the file specified by |
| File(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns the file specified by |
| File(String, String, String, Boolean) |
Returns the file specified by |
| File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns the file specified by |
| File(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns the file specified by |
| File(String, String, String) |
Returns the file specified by |
| File(String, String) |
Returns the file specified by |
| Forbid() |
Creates a ForbidResult (Status403Forbidden by default). |
| Forbid(AuthenticationProperties, String[]) |
Creates a ForbidResult (Status403Forbidden by default) with the
specified authentication schemes and |
| Forbid(AuthenticationProperties, String[]) |
Creates a ForbidResult with the specified specified authentication schemes and
|
| Forbid(AuthenticationProperties) |
Creates a ForbidResult (Status403Forbidden by default) with the
specified |
| Forbid(AuthenticationProperties) |
Creates a ForbidResult with the specified |
| Forbid(String[]) |
Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes. |
| LocalRedirect(String) |
Creates a LocalRedirectResult object that redirects
(Status302Found) to the specified local |
| LocalRedirectPermanent(String) |
Creates a LocalRedirectResult object with Permanent set to
true (Status301MovedPermanently) using the specified |
| LocalRedirectPermanentPreserveMethod(String) |
Creates a LocalRedirectResult object with Permanent set to
true and PreserveMethod set to true
(Status308PermanentRedirect) using the specified |
| LocalRedirectPreserveMethod(String) |
Creates a LocalRedirectResult object with Permanent set to
false and PreserveMethod set to true
(Status307TemporaryRedirect) using the specified |
| NoContent() |
Creates a NoContentResult object that produces an empty Status204NoContent response. |
| NotFound() |
Creates a NotFoundResult that produces a Status404NotFound response. |
| NotFound(Object) |
Creates a NotFoundObjectResult that produces a Status404NotFound response. |
| Ok() |
Creates an OkResult object that produces an empty Status200OK response. |
| Ok(Object) |
Creates an OkObjectResult object that produces a Status200OK response. |
| PhysicalFile(String, String, Boolean) |
Returns the file specified by |
| PhysicalFile(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns the file specified by |
| PhysicalFile(String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns the file specified by |
| PhysicalFile(String, String, String, Boolean) |
Returns the file specified by |
| PhysicalFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue, Boolean) |
Returns the file specified by |
| PhysicalFile(String, String, String, Nullable<DateTimeOffset>, EntityTagHeaderValue) |
Returns the file specified by |
| PhysicalFile(String, String, String) |
Returns the file specified by |
| PhysicalFile(String, String) |
Returns the file specified by |
| Problem(String, String, Nullable<Int32>, String, String, IDictionary<String,Object>) |
Creates an ObjectResult that produces a ProblemDetails response. |
| Problem(String, String, Nullable<Int32>, String, String) |
Creates an ObjectResult that produces a ProblemDetails response. |
| Redirect(String) |
Creates a RedirectResult object that redirects (Status302Found)
to the specified |
| RedirectPermanent(String) |
Creates a RedirectResult object with Permanent set to true
(Status301MovedPermanently) using the specified |
| RedirectPermanentPreserveMethod(String) |
Creates a RedirectResult object with Permanent set to true
and PreserveMethod set to true (Status308PermanentRedirect)
using the specified |
| RedirectPreserveMethod(String) |
Creates a RedirectResult object with Permanent set to false
and PreserveMethod set to true (Status307TemporaryRedirect)
using the specified |
| RedirectToAction() |
Redirects (Status302Found) to an action with the same name as current one. The 'controller' and 'action' names are retrieved from the ambient values of the current request. |
| RedirectToAction(String, Object) |
Redirects (Status302Found) to the specified action using the
|
| RedirectToAction(String, String, Object, String) |
Redirects (Status302Found) to the specified action using the specified |
| RedirectToAction(String, String, Object) |
Redirects (Status302Found) to the specified action using the specified
|
| RedirectToAction(String, String, String) |
Redirects (Status302Found) to the specified action using the specified
|
| RedirectToAction(String, String) |
Redirects (Status302Found) to the specified action using the
|
| RedirectToAction(String) |
Redirects (Status302Found) to the specified action using the |
| RedirectToActionPermanent(String, Object) |
Redirects (Status301MovedPermanently) to the specified action with
Permanent set to true using the specified |
| RedirectToActionPermanent(String, String, Object, String) |
Redirects (Status301MovedPermanently) to the specified action with
Permanent set to true using the specified |
| RedirectToActionPermanent(String, String, Object) |
Redirects (Status301MovedPermanently) to the specified action with
Permanent set to true using the specified |
| RedirectToActionPermanent(String, String, String) |
Redirects (Status301MovedPermanently) to the specified action with
Permanent set to true using the specified |
| RedirectToActionPermanent(String, String) |
Redirects (Status301MovedPermanently) to the specified action with
Permanent set to true using the specified |
| RedirectToActionPermanent(String) |
Redirects (Status301MovedPermanently) to the specified action with
Permanent set to true using the specified |
| RedirectToActionPermanentPreserveMethod(String, String, Object, String) |
Redirects (Status308PermanentRedirect) to the specified action with
Permanent set to true and PreserveMethod
set to true, using the specified |
| RedirectToActionPreserveMethod(String, String, Object, String) |
Redirects (Status307TemporaryRedirect) to the specified action with
Permanent set to false and PreserveMethod
set to true, using the specified |
| RedirectToPage(String, Object) |
Redirects (Status302Found) to the specified |
| RedirectToPage(String, String, Object, String) |
Redirects (Status302Found) to the specified |
| RedirectToPage(String, String, Object) |
Redirects (Status302Found) to the specified |
| RedirectToPage(String, String, String) |
Redirects (Status302Found) to the specified |
| RedirectToPage(String, String) |
Redirects (Status302Found) to the specified |
| RedirectToPage(String) |
Redirects (Status302Found) to the specified |
| RedirectToPagePermanent(String, Object) |
Redirects (Status301MovedPermanently) to the specified |
| RedirectToPagePermanent(String, String, Object, String) |
Redirects (Status301MovedPermanently) to the specified |
| RedirectToPagePermanent(String, String, String) |
Redirects (Status301MovedPermanently) to the specified |
| RedirectToPagePermanent(String, String) |
Redirects (Status301MovedPermanently) to the specified |
| RedirectToPagePermanent(String) |
Redirects (Status301MovedPermanently) to the specified |
| RedirectToPagePermanentPreserveMethod(String, String, Object, String) |
Redirects (Status308PermanentRedirect) to the specified route with
Permanent set to true and PreserveMethod
set to true, using the specified |
| RedirectToPagePreserveMethod(String, String, Object, String) |
Redirects (Status307TemporaryRedirect) to the specified page with
Permanent set to false and PreserveMethod
set to true, using the specified |
| RedirectToRoute(Object) |
Redirects (Status302Found) to the specified route using the specified |
| RedirectToRoute(String, Object, String) |
Redirects (Status302Found) to the specified route using the specified
|
| RedirectToRoute(String, Object) |
Redirects (Status302Found) to the specified route using the specified
|
| RedirectToRoute(String, String) |
Redirects (Status302Found) to the specified route using the specified
|
| RedirectToRoute(String) |
Redirects (Status302Found) to the specified route using the specified |
| RedirectToRoutePermanent(Object) |
Redirects (Status301MovedPermanently) to the specified route with
Permanent set to true using the specified |
| RedirectToRoutePermanent(String, Object, String) |
Redirects (Status301MovedPermanently) to the specified route with
Permanent set to true using the specified |
| RedirectToRoutePermanent(String, Object) |
Redirects (Status301MovedPermanently) to the specified route with
Permanent set to true using the specified |
| RedirectToRoutePermanent(String, String) |
Redirects (Status301MovedPermanently) to the specified route with
Permanent set to true using the specified |
| RedirectToRoutePermanent(String) |
Redirects (Status301MovedPermanently) to the specified route with
Permanent set to true using the specified |
| RedirectToRoutePermanentPreserveMethod(String, Object, String) |
Redirects (Status308PermanentRedirect) to the specified route with
Permanent set to true and PreserveMethod
set to true, using the specified |
| RedirectToRoutePreserveMethod(String, Object, String) |
Redirects (Status307TemporaryRedirect) to the specified route with
Permanent set to false and PreserveMethod
set to true, using the specified |
| SignIn(ClaimsPrincipal, AuthenticationProperties, String) |
Creates a SignInResult with the specified specified authentication scheme and
|
| SignIn(ClaimsPrincipal, AuthenticationProperties, String) |
Creates a SignInResult with the specified authentication scheme and
|
| SignIn(ClaimsPrincipal, AuthenticationProperties) |
Creates a SignInResult with |
| SignIn(ClaimsPrincipal, String) |
Creates a SignInResult with the specified authentication scheme. |
| SignIn(ClaimsPrincipal) |
Creates a SignInResult. |
| SignOut() |
Creates a SignOutResult. |
| SignOut(AuthenticationProperties, String[]) |
Creates a SignOutResult with the specified authentication schemes and
|
| SignOut(AuthenticationProperties, String[]) |
Creates a SignOutResult with the specified specified authentication schemes and
|
| SignOut(AuthenticationProperties) |
Creates a SignOutResult with |
| SignOut(String[]) |
Creates a SignOutResult with the specified authentication schemes. |
| StatusCode(Int32, Object) |
Creates an ObjectResult object by specifying a |
| StatusCode(Int32) |
Creates a StatusCodeResult object by specifying a |
| TryUpdateModelAsync(Object, Type, String, IValueProvider, Func<ModelMetadata,Boolean>) |
Updates the specified |
| TryUpdateModelAsync(Object, Type, String) |
Updates the specified |
| TryUpdateModelAsync<TModel>(TModel, String, Expression<Func<TModel,Object>>[]) |
Updates the specified |
| TryUpdateModelAsync<TModel>(TModel, String, Func<ModelMetadata,Boolean>) |
Updates the specified |
| TryUpdateModelAsync<TModel>(TModel, String, IValueProvider, Expression<Func<TModel,Object>>[]) |
Updates the specified |
| TryUpdateModelAsync<TModel>(TModel, String, IValueProvider, Func<ModelMetadata,Boolean>) |
Updates the specified |
| TryUpdateModelAsync<TModel>(TModel, String, IValueProvider) |
Updates the specified |
| TryUpdateModelAsync<TModel>(TModel, String) |
Updates the specified |
| TryUpdateModelAsync<TModel>(TModel) |
Updates the specified |
| TryValidateModel(Object, String) |
Validates the specified |
| TryValidateModel(Object) |
Validates the specified |
| Unauthorized() |
Creates an UnauthorizedResult that produces a Status401Unauthorized response. |
| Unauthorized(Object) |
Creates an UnauthorizedObjectResult that produces a Status401Unauthorized response. |
| UnprocessableEntity() |
Creates an UnprocessableEntityResult that produces a Status422UnprocessableEntity response. |
| UnprocessableEntity(ModelStateDictionary) |
Creates an UnprocessableEntityObjectResult that produces a Status422UnprocessableEntity response. |
| UnprocessableEntity(Object) |
Creates an UnprocessableEntityObjectResult that produces a Status422UnprocessableEntity response. |
| ValidationProblem() |
Creates an ActionResult that produces a Status400BadRequest response with validation errors from ModelState. |
| ValidationProblem(ModelStateDictionary) |
Creates an ActionResult that produces a Status400BadRequest response
with validation errors from |
| ValidationProblem(String, String, Nullable<Int32>, String, String, ModelStateDictionary, IDictionary<String,Object>) |
Creates an ActionResult that produces a Status400BadRequest response with a ValidationProblemDetails value. |
| ValidationProblem(String, String, Nullable<Int32>, String, String, ModelStateDictionary) |
Creates an ActionResult that produces a Status400BadRequest response with a ValidationProblemDetails value. |
| ValidationProblem(ValidationProblemDetails) |
Creates a BadRequestObjectResult that produces a Status400BadRequest response. |
Applies to
Feedback
Was this page helpful?
