PageBase 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

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: PageBase.cs

Source:: PageBase.cs

Source:: PageBase.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 a Razor page.

public ref class PageBase abstract : Microsoft::AspNetCore::Mvc::Razor::RazorPageBase

public abstract class PageBase : Microsoft.AspNetCore.Mvc.Razor.RazorPageBase

type PageBase = class
    inherit RazorPageBase

Public MustInherit Class PageBase
Inherits RazorPageBase

Inheritance: Object

RazorPageBase
PageBase

Derived: Microsoft.AspNetCore.Mvc.RazorPages.Page

Constructors

PageBase()

Properties

BodyContent	Gets or sets the body content. (Inherited from RazorPageBase)
DiagnosticSource	Gets or sets a DiagnosticSource instance used to instrument the page execution. (Inherited from RazorPageBase)
HtmlEncoder	Gets the HtmlEncoder to use when this RazorPage handles non-IHtmlContent C# expressions. (Inherited from RazorPageBase)
HttpContext	Gets the HttpContext.
IsLayoutBeingRendered	Gets or sets a flag that determines if the layout of this page is being rendered. (Inherited from RazorPageBase)
Layout	Gets or sets the path of a layout page. (Inherited from RazorPageBase)
MetadataProvider	Gets or sets the IModelMetadataProvider.
ModelState	Gets the ModelStateDictionary.
Output	Gets the TextWriter that the page is writing output to. (Inherited from RazorPageBase)
PageContext	The PageContext.
Path	Gets the application base relative path to the page. (Inherited from RazorPageBase)
PreviousSectionWriters	Gets or sets the sections that can be rendered by this page. (Inherited from RazorPageBase)
Request	Gets the HttpRequest.
Response	Gets the HttpResponse.
RouteData	Gets the RouteData for the executing action.
SectionWriters	Gets the sections that are defined by this page. (Inherited from RazorPageBase)
TempData	Gets the ITempDataDictionary from the ViewContext. (Inherited from RazorPageBase)
User	Gets the ClaimsPrincipal of the current logged in user. (Inherited from RazorPageBase)
ViewBag	Gets the dynamic view data dictionary. (Inherited from RazorPageBase)
ViewContext	Gets or sets the view context of the rendering view.

Methods

AddHtmlAttributeValue(String, Int32, Object, Int32, Int32, Boolean)	Add an html attribute value. (Inherited from RazorPageBase)
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.
BeginAddHtmlAttributeValues(TagHelperExecutionContext, String, Int32, HtmlAttributeValueStyle)	Begins adding html attribute values. (Inherited from RazorPageBase)
BeginContext(Int32, Int32, Boolean)	System.Object.BeginContext(System.Int32,System.Int32,System.Boolean)
BeginWriteAttribute(String, String, Int32, String, Int32, Int32)	Begins writing out an attribute. (Inherited from RazorPageBase)
BeginWriteTagHelperAttribute()	Starts a new scope for writing ITagHelper attribute values. (Inherited from RazorPageBase)
Challenge()	Creates a ChallengeResult.
Challenge(AuthenticationProperties, String[])	Creates a ChallengeResult with the specified authentication schemes and `properties`.
Challenge(AuthenticationProperties)	Creates a ChallengeResult with the specified `properties`.
Challenge(String[])	Creates a ChallengeResult with the specified authentication schemes.
Content(String, MediaTypeHeaderValue)	Creates a ContentResult object with Status200OK by specifying a `content` string and a `contentType`.
Content(String, String, Encoding)	Creates a ContentResult object with Status200OK by specifying a `content` string, a `contentType`, and `contentEncoding`.
Content(String, String)	Creates a ContentResult object with Status200OK by specifying a `content` string and a content type.
Content(String)	Creates a ContentResult object with Status200OK by specifying a `content` string.
CreateTagHelper<TTagHelper>()	Creates and activates a ITagHelper. (Inherited from RazorPageBase)
DefineSection(String, Func<Object,Task>)	Creates a named content section in the page that can be invoked in a Layout page using `RenderSection` or `RenderSectionAsync` (Inherited from RazorPageBase)
DefineSection(String, RenderAsyncDelegate)	Creates a named content section in the page that can be invoked in a Layout page using `RenderSection` or `RenderSectionAsync` (Inherited from RazorPageBase)
EndAddHtmlAttributeValues(TagHelperExecutionContext)	Ends adding html attribute values. (Inherited from RazorPageBase)
EndContext()	System.Object.EndContext
EndTagHelperWritingScope()	Ends the current writing scope that was started by calling StartTagHelperWritingScope(HtmlEncoder). (Inherited from RazorPageBase)
EndWriteAttribute()	Ends writing an attribute. (Inherited from RazorPageBase)
EndWriteTagHelperAttribute()	Ends the current writing scope that was started by calling BeginWriteTagHelperAttribute(). (Inherited from RazorPageBase)
EnsureRenderedBodyOrSections()	Verifies that all sections defined in PreviousSectionWriters were rendered, or the body was rendered if no sections were defined.
ExecuteAsync()	Renders the page and writes the output to the Writer. (Inherited from RazorPageBase)
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(Byte[], String)	Returns a file with the specified `fileContents` as content (Status200OK) and 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(Stream, String)	Returns a file in the specified `fileStream` (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.
File(String, String)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type.
FlushAsync()	Invokes FlushAsync() on Output and Stream.FlushAsync on the response stream, writing out any buffered content to the Body. (Inherited from RazorPageBase)
Forbid()	Creates a ForbidResult (Status403Forbidden by default).
Forbid(AuthenticationProperties, String[])	Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes and `properties`.
Forbid(AuthenticationProperties)	Creates a ForbidResult (Status403Forbidden by default) with the specified `properties`.
Forbid(String[])	Creates a ForbidResult (Status403Forbidden by default) with the specified authentication schemes.
Href(String)	Returns a href for the given content path. (Inherited from RazorPageBase)
InvalidTagHelperIndexerAssignment(String, String, String)	Format an error message about using an indexer when the tag helper property is `null`. (Inherited from RazorPageBase)
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.
Page()	Creates a PageResult object that renders this page as a view to the response.
Partial(String, Object)	Creates a PartialViewResult by specifying the name of a partial to render and the model object.
Partial(String)	Creates a PartialViewResult by specifying the name of a partial to render.
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.
PhysicalFile(String, String)	Returns the file specified by `physicalPath` (Status200OK) with the specified `contentType` as the Content-Type.
PopWriter()	Return a text writer from the stack. (Inherited from RazorPageBase)
PushWriter(TextWriter)	Puts a text writer on the stack. (Inherited from RazorPageBase)
Redirect(String)	Creates a RedirectResult object that redirects 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, Object)	Redirects (Status302Found) to the specified action using the `actionName` and `routeValues`.
RedirectToAction(String, String, Object, String)	Redirects (Status302Found) to the specified action using the specified `actionName`, `controllerName`, `routeValues`, and `fragment`.
RedirectToAction(String, String, Object)	Redirects (Status302Found) to the specified action using the specified `actionName`, `controllerName`, and `routeValues`.
RedirectToAction(String, String, String)	Redirects (Status302Found) to the specified action using the specified `actionName`, `controllerName`, and `fragment`.
RedirectToAction(String, String)	Redirects (Status302Found) to the specified action using the `actionName` and the `controllerName`.
RedirectToAction(String)	Redirects (Status302Found) to the specified action using the `actionName`.
RedirectToActionPermanent(String, Object)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName` 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, Object)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName`, `controllerName`, and `routeValues`.
RedirectToActionPermanent(String, String, String)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName`, `controllerName`, and `fragment`.
RedirectToActionPermanent(String, String)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName` and `controllerName`.
RedirectToActionPermanent(String)	Redirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified `actionName`.
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, Object)	Redirects (Status302Found) to the specified `pageName` using the specified `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`.
RedirectToPage(String, String)	Redirects (Status302Found) to the specified `pageName` using the specified `pageHandler`.
RedirectToPage(String)	Redirects (Status302Found) to the specified `pageName`.
RedirectToPagePermanent(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, Object)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `routeValues`.
RedirectToPagePermanent(String, String, String)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `fragment`.
RedirectToPagePermanent(String, String)	Redirects (Status301MovedPermanently) to the specified `pageName` using the specified `pageHandler`.
RedirectToPagePermanent(String)	Redirects (Status301MovedPermanently) to the specified `pageName`.
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, Object, String)	Redirects (Status302Found) to the specified route using the specified `routeName`, `routeValues`, and `fragment`.
RedirectToRoute(String, Object)	Redirects (Status302Found) to the specified route using the specified `routeName` and `routeValues`.
RedirectToRoute(String, String)	Redirects (Status302Found) to the specified route using the specified `routeName` and `fragment`.
RedirectToRoute(String)	Redirects (Status302Found) to the specified route using the specified `routeName`.
RedirectToRoutePermanent(Object)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `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, Object)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeName` and `routeValues`.
RedirectToRoutePermanent(String, String)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeName` and `fragment`.
RedirectToRoutePermanent(String)	Redirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified `routeName`.
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`.
SetAntiforgeryCookieAndHeader()	Sets antiforgery cookie and X-Frame-Options header on the response. (Inherited from RazorPageBase)
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.
StartTagHelperWritingScope(HtmlEncoder)	Starts a new writing scope and optionally overrides HtmlEncoder within that scope. (Inherited from RazorPageBase)
StatusCode(Int32, Object)	Creates a ObjectResult object by specifying a `statusCode` and `value`
StatusCode(Int32)	Creates a StatusCodeResult object by specifying a `statusCode`.
TryUpdateModelAsync(Object, Type, String, IValueProvider, Func<ModelMetadata,Boolean>)	Updates the specified `model` instance using the `valueProvider` and a `prefix`.
TryUpdateModelAsync(Object, Type, String)	Updates the specified `model` instance using values from the Page's current IValueProvider and a `prefix`.
TryUpdateModelAsync<TModel>(TModel, String, Expression<Func<TModel,Object>>[])	Updates the specified `model` instance using values from the Page's current IValueProvider and a `prefix`.
TryUpdateModelAsync<TModel>(TModel, String, Func<ModelMetadata,Boolean>)	Updates the specified `model` instance using values from the Page's current IValueProvider and a `prefix`.
TryUpdateModelAsync<TModel>(TModel, String, IValueProvider, Expression<Func<TModel,Object>>[])	Updates the specified `model` instance using the `valueProvider` and a `prefix`.
TryUpdateModelAsync<TModel>(TModel, String, IValueProvider, Func<ModelMetadata,Boolean>)	Updates the specified `model` instance using the `valueProvider` and a `prefix`.
TryUpdateModelAsync<TModel>(TModel, String, IValueProvider)	Updates the specified `model` instance using the `valueProvider` and a `prefix`.
TryUpdateModelAsync<TModel>(TModel, String)	Updates the specified `model` instance using values from the Page's current IValueProvider and a `prefix`.
TryUpdateModelAsync<TModel>(TModel)	Updates the specified `model` instance using values from the Page's current IValueProvider.
TryValidateModel(Object, String)	Validates the specified `model` instance.
TryValidateModel(Object)	Validates the specified `model` instance.
Unauthorized()	Creates an UnauthorizedResult that produces an Status401Unauthorized response.
ViewComponent(String, Object)	Creates a ViewComponentResult by specifying the name of a view component to render.
ViewComponent(String)	Creates a ViewComponentResult by specifying the name of a view component to render.
ViewComponent(Type, Object)	Creates a ViewComponentResult by specifying the Type of a view component to render.
ViewComponent(Type)	Creates a ViewComponentResult by specifying the Type of a view component to render.
Write(Object)	Writes the specified `value` with HTML encoding to Output. (Inherited from RazorPageBase)
Write(String)	Writes the specified `value` with HTML encoding to Output. (Inherited from RazorPageBase)
WriteAttributeValue(String, Int32, Object, Int32, Int32, Boolean)	Writes out an attribute value. (Inherited from RazorPageBase)
WriteLiteral(Object)	Writes the specified `value` without HTML encoding to Output. (Inherited from RazorPageBase)
WriteLiteral(String)	Writes the specified `value` without HTML encoding to Output. (Inherited from RazorPageBase)

Applies to

Share via