PageModel Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.RazorPages

Assembly:: Microsoft.AspNetCore.Mvc.RazorPages.dll

Package:: Microsoft.AspNetCore.Mvc.RazorPages v2.0.0

Package:: Microsoft.AspNetCore.Mvc.RazorPages v2.1.0

Package:: Microsoft.AspNetCore.Mvc.RazorPages 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.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Source:: PageModel.cs

Source:: PageModel.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.

Abstract class representing a Page

public ref class PageModel abstract

public ref class PageModel abstract : Microsoft::AspNetCore::Mvc::Filters::IAsyncPageFilter, Microsoft::AspNetCore::Mvc::Filters::IFilterMetadata, Microsoft::AspNetCore::Mvc::Filters::IPageFilter

[Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageModel]
public abstract class PageModel

[Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageModel]
public abstract class PageModel : Microsoft.AspNetCore.Mvc.Filters.IAsyncPageFilter, Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata, Microsoft.AspNetCore.Mvc.Filters.IPageFilter

[<Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageModel>]
type PageModel = class

[<Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure.PageModel>]
type PageModel = class
    interface IAsyncPageFilter
    interface IFilterMetadata
    interface IPageFilter

Public MustInherit Class PageModel

Public MustInherit Class PageModel
Implements IAsyncPageFilter, IFilterMetadata, IPageFilter

Inheritance: Object
PageModel

Derived: Microsoft.AspNetCore.Identity.UI.Pages.ErrorModel

Microsoft.AspNetCore.Identity.UI.V5.Pages.Account.Internal.AccessDeniedModel

Microsoft.AspNetCore.Identity.UI.V5.Pages.Account.Internal.ConfirmEmailChangeModel

Microsoft.AspNetCore.Identity.UI.V5.Pages.Account.Internal.ConfirmEmailModel

Microsoft.AspNetCore.Identity.UI.V5.Pages.Account.Internal.ExternalLoginModel

More…

Attributes: PageModelAttribute

Implements: IAsyncPageFilter IFilterMetadata IPageFilter

Constructors

PageModel()

Properties

HttpContext	Gets the HttpContext.
MetadataProvider	Gets or sets the IModelMetadataProvider.
ModelState	Gets the ModelStateDictionary.
PageContext	Gets the PageContext.
Request	Gets the HttpRequest.
Response	Gets the HttpResponse.
RouteData	Gets the RouteData for the executing action.
TempData	Gets or sets ITempDataDictionary used by PageResult.
Url	Gets or sets the IUrlHelper.
User	Gets the ClaimsPrincipal for user associated with the executing action.
ViewData	Gets the ViewDataDictionary.

Methods

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)	Creates a ChallengeResult with the specified `properties`.
Challenge(AuthenticationProperties, String[])	Creates a ChallengeResult with the specified authentication schemes and `properties`.
Challenge(String[])	Creates a ChallengeResult with the specified authentication schemes.
Content(String)	Creates a ContentResult object with Status200OK by specifying a `content` string.
Content(String, MediaTypeHeaderValue)	Creates a ContentResult object with Status200OK by specifying a `content` string and a `contentType`.
Content(String, String)	Creates a ContentResult object with Status200OK by specifying a `content` string and a content type.
Content(String, String, Encoding)	Creates a ContentResult object with Status200OK by specifying a `content` string, a `contentType`, and `contentEncoding`.
File(Byte[], String)	Returns a file with the specified `fileContents` as content (Status200OK) and the specified `contentType` as the Content-Type.
File(Byte[], String, String)	Returns a file with the specified `fileContents` as content (Status200OK), the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name.
File(Stream, String)	Returns a file in the specified `fileStream` (Status200OK) with the specified `contentType` as the Content-Type.
File(Stream, String, String)	Returns a file in the specified `fileStream` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name.
File(String, String)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type.
File(String, String, String)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name.
Forbid()	Creates a ForbidResult (Status403Forbidden by default).
Forbid(AuthenticationProperties)	Creates a ForbidResult (Status403Forbidden by default) with the specified `properties`.
Forbid(AuthenticationProperties, String[])	Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes and `properties`.
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 `localUrl`.
LocalRedirectPermanent(String)	Creates a LocalRedirectResult object with Permanent set to true (Status301MovedPermanently) using the specified `localUrl`.
LocalRedirectPermanentPreserveMethod(String)	Creates a LocalRedirectResult object with Permanent set to true and PreserveMethod set to true (Status308PermanentRedirect) using the specified `localUrl`.
LocalRedirectPreserveMethod(String)	Creates a LocalRedirectResult object with Permanent set to false and PreserveMethod set to true (Status307TemporaryRedirect) using the specified `localUrl`.
NotFound()	Creates an NotFoundResult that produces a Status404NotFound response.
NotFound(Object)	Creates an NotFoundObjectResult that produces a Status404NotFound response.
OnPageHandlerExecuted(PageHandlerExecutedContext)	Called after the handler method executes, before the action result executes.
OnPageHandlerExecuting(PageHandlerExecutingContext)	Called before the handler method executes, after model binding is complete.
OnPageHandlerExecutionAsync(PageHandlerExecutingContext, PageHandlerExecutionDelegate)	Called asynchronously before the handler method is invoked, after model binding is complete.
OnPageHandlerSelected(PageHandlerSelectedContext)	Called after a handler method has been selected, but before model binding occurs.
OnPageHandlerSelectionAsync(PageHandlerSelectedContext)	Called asynchronously after the handler method has been selected, but before model binding occurs.
Page()	Creates a PageResult object that renders the page.
Partial(String)	Creates a PartialViewResult by specifying the name of a partial to render.
Partial(String, Object)	Creates a PartialViewResult by specifying the name of a partial to render and the model object.
PhysicalFile(String, String)	Returns the file specified by `physicalPath` (Status200OK) with the specified `contentType` as the Content-Type.
PhysicalFile(String, String, String)	Returns the file specified by `physicalPath` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name.
Redirect(String)	Creates a RedirectResult object that redirects (Status302Found) to the specified `url`.
RedirectPermanent(String)	Creates a RedirectResult object with Permanent set to true (Status301MovedPermanently) using the specified `url`.
RedirectPermanentPreserveMethod(String)	Creates a RedirectResult object with Permanent set to true and PreserveMethod set to true (Status308PermanentRedirect) using the specified `url`.
RedirectPreserveMethod(String)	Creates a RedirectResult object with Permanent set to false and PreserveMethod set to true (Status307TemporaryRedirect) using the specified `url`.
RedirectToAction(String)	Redirects (Status302Found) to the specified action using the `actionName`.
RedirectToAction(String, Object)	Redirects (Status302Found) to the specified action using the `actionName` and `routeValues`.
RedirectToAction(String, String)	Redirects (Status302Found) to the specified action using the `actionName` and the `controllerName`.
RedirectToAction(String, String, Object)	Redirects (Status302Found) to the specified action using the specified `actionName`, `controllerName`, and `routeValues`.
RedirectToAction(String, String, Object, String)	Redirects (Status302Found) to the specified action using the specified `actionName`, `controllerName`, `routeValues`, and `fragment`.
RedirectToAction(String, String, String)	Redirects (Status302Found) to the specified action using the specified `actionName`, `controllerName`, and `fragment`.
RedirectToActionPermanent(String)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName`.
RedirectToActionPermanent(String, Object)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName` and `routeValues`.
RedirectToActionPermanent(String, String)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName` and `controllerName`.
RedirectToActionPermanent(String, String, Object)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName`, `controllerName`, and `routeValues`.
RedirectToActionPermanent(String, String, Object, String)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName`, `controllerName`, `routeValues`, and `fragment`.
RedirectToActionPermanent(String, String, String)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName`, `controllerName`, and `fragment`.
RedirectToActionPermanentPreserveMethod(String, String, Object, String)	Redirects (Status308PermanentRedirect) to the specified action with Permanent set to true and PreserveMethod set to true, using the specified `actionName`, `controllerName`, `routeValues`, and `fragment`.
RedirectToActionPreserveMethod(String, String, Object, String)	Redirects (Status307TemporaryRedirect) to the specified action with Permanent set to false and PreserveMethod set to true, using the specified `actionName`, `controllerName`, `routeValues`, and `fragment`.
RedirectToPage()	Redirects (Status302Found) to the current page.
RedirectToPage(Object)	Redirects (Status302Found) to the current page with the specified `routeValues`.
RedirectToPage(String)	Redirects (Status302Found) to the specified `pageName`.
RedirectToPage(String, Object)	Redirects (Status302Found) to the specified `pageName` using the specified `routeValues`.
RedirectToPage(String, String)	Redirects (Status302Found) to the specified `pageName` using the specified `pageHandler`.
RedirectToPage(String, String, Object)	Redirects (Status302Found) to the specified `pageName` using the specified `pageHandler` and `routeValues`.
RedirectToPage(String, String, Object, String)	Redirects (Status302Found) to the specified `pageName` using the specified `routeValues` and `fragment`.
RedirectToPage(String, String, String)	Redirects (Status302Found) to the specified `pageName` using the specified `fragment`.
RedirectToPagePermanent(String)	Redirects (Status301MovedPermanently) to the specified `pageName`.
RedirectToPagePermanent(String, Object)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `routeValues`.
RedirectToPagePermanent(String, Object, String)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `fragment`.
RedirectToPagePermanent(String, String)	Redirects (Status301MovedPermanently) to the specified `pageName`.
RedirectToPagePermanent(String, String, Object)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `routeValues`.
RedirectToPagePermanent(String, String, Object, String)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `routeValues` and `fragment`.
RedirectToPagePermanent(String, String, String)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `fragment`.
RedirectToPagePermanentPreserveMethod(String, String, Object, String)	Redirects (Status308PermanentRedirect) to the specified route with Permanent set to true and PreserveMethod set to true, using the specified `pageName`, `routeValues`, and `fragment`.
RedirectToPagePreserveMethod(String, String, Object, String)	Redirects (Status307TemporaryRedirect) to the specified page with Permanent set to false and PreserveMethod set to true, using the specified `pageName`, `routeValues`, and `fragment`.
RedirectToRoute(Object)	Redirects (Status302Found) to the specified route using the specified `routeValues`.
RedirectToRoute(String)	Redirects (Status302Found) to the specified route using the specified `routeName`.
RedirectToRoute(String, Object)	Redirects (Status302Found) to the specified route using the specified `routeName` and `routeValues`.
RedirectToRoute(String, Object, String)	Redirects (Status302Found) to the specified route using the specified `routeName`, `routeValues`, and `fragment`.
RedirectToRoute(String, String)	Redirects (Status302Found) to the specified route using the specified `routeName` and `fragment`.
RedirectToRoutePermanent(Object)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeValues`.
RedirectToRoutePermanent(String)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeName`.
RedirectToRoutePermanent(String, Object)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeName` and `routeValues`.
RedirectToRoutePermanent(String, Object, String)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeName`, `routeValues`, and `fragment`.
RedirectToRoutePermanent(String, String)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeName` and `fragment`.
RedirectToRoutePermanentPreserveMethod(String, Object, String)	Redirects (Status308PermanentRedirect) to the specified route with Permanent set to true and PreserveMethod set to true, using the specified `routeName`, `routeValues`, and `fragment`.
RedirectToRoutePreserveMethod(String, Object, String)	Redirects (Status307TemporaryRedirect) to the specified route with Permanent set to false and PreserveMethod set to true, using the specified `routeName`, `routeValues`, and `fragment`.
SignIn(ClaimsPrincipal, AuthenticationProperties, String)	Creates a SignInResult with the specified authentication scheme and `properties`.
SignIn(ClaimsPrincipal, String)	Creates a SignInResult with the specified authentication scheme.
SignOut(AuthenticationProperties, String[])	Creates a SignOutResult with the specified authentication schemes and `properties`.
SignOut(String[])	Creates a SignOutResult with the specified authentication schemes.
StatusCode(Int32)	Creates a StatusCodeResult object by specifying a `statusCode`.
StatusCode(Int32, Object)	Creates a ObjectResult object by specifying a `statusCode` and `value`
TryUpdateModelAsync(Object, Type, String)	Updates the specified `model` instance using values from the PageModel's current IValueProvider and a `name`.
TryUpdateModelAsync(Object, Type, String, IValueProvider, Func<ModelMetadata,Boolean>)	Updates the specified `model` instance using the `valueProvider` and a `name`.
TryUpdateModelAsync<TModel>(TModel)	Updates the specified `model` instance using values from the PageModel's current IValueProvider.
TryUpdateModelAsync<TModel>(TModel, String)	Updates the specified `model` instance using values from the PageModel's current IValueProvider.
TryUpdateModelAsync<TModel>(TModel, String, Expression<Func<TModel,Object>>[])	Updates the specified `model` instance using values from the PageModel's current IValueProvider and a `name`.
TryUpdateModelAsync<TModel>(TModel, String, Func<ModelMetadata,Boolean>)	Updates the specified `model` instance using values from the PageModel's current IValueProvider and a `name`.
TryUpdateModelAsync<TModel>(TModel, String, IValueProvider)	Updates the specified `model` instance using the `valueProvider` and a `name`.
TryUpdateModelAsync<TModel>(TModel, String, IValueProvider, Expression<Func<TModel,Object>>[])	Updates the specified `model` instance using the `valueProvider` and a `name`.
TryUpdateModelAsync<TModel>(TModel, String, IValueProvider, Func<ModelMetadata,Boolean>)	Updates the specified `model` instance using the `valueProvider` and a `name`.
TryValidateModel(Object)	Validates the specified `model` instance.
TryValidateModel(Object, String)	Validates the specified `model` instance.
Unauthorized()	Creates an UnauthorizedResult that produces an Status401Unauthorized response.
ViewComponent(String)	Creates a ViewComponentResult by specifying the name of a view component to render.
ViewComponent(String, Object)	Creates a ViewComponentResult by specifying the name of a view component to render.
ViewComponent(Type)	Creates a ViewComponentResult by specifying the Type of a view component to render.
ViewComponent(Type, Object)	Creates a ViewComponentResult by specifying the Type of a view component to render.

Applies to