9.6 KiB
Scaffolded Razor Pages in ASP.NET Core
This tutorial examines the Razor Pages created by scaffolding in the previous tutorial.
View or download sample.
The Create, Delete, Details, and Edit pages.
Examine the Pages/Movies/Index.cshtml.cs Page Model:
::: moniker range="= aspnetcore-2.0"
::: moniker-end
::: moniker range=">= aspnetcore-2.1"
::: moniker-end
Razor Pages are derived from PageModel. By convention, the PageModel-derived class is called <PageName>Model. The constructor uses dependency injection to add the MovieContext to the page. All the scaffolded pages follow this pattern. See Asynchronous code for more information on asynchronous programming with Entity Framework.
When a request is made for the page, the OnGetAsync method returns a list of movies to the Razor Page. OnGetAsync or OnGet is called on a Razor Page to initialize the state for the page. In this case, OnGetAsync gets a list of movies and displays them.
When OnGet returns void or OnGetAsync returnsTask, no return method is used. When the return type is IActionResult or Task<IActionResult>, a return statement must be provided. For example, the Pages/Movies/Create.cshtml.cs OnPostAsync method:
Examine the Pages/Movies/Index.cshtml Razor Page:
Razor can transition from HTML into C# or into Razor-specific markup. When an @ symbol is followed by a Razor reserved keyword, it transitions into Razor-specific markup, otherwise it transitions into C#.
The @page Razor directive makes the file into an MVC action — which means that it can handle requests. @page must be the first Razor directive on a page. @page is an example of transitioning into Razor-specific markup. See Razor syntax for more information.
Examine the lambda expression used in the following HTML Helper:
@Html.DisplayNameFor(model => model.Movie[0].Title))
The DisplayNameFor HTML Helper inspects the Title property referenced in the lambda expression to determine the display name. The lambda expression is inspected rather than evaluated. That means there is no access violation when model, model.Movie, or model.Movie[0] are null or empty. When the lambda expression is evaluated (for example, with @Html.DisplayFor(modelItem => item.Title)), the model's property values are evaluated.
The @model directive
The @model directive specifies the type of the model passed to the Razor Page. In the preceding example, the @model line makes the PageModel-derived class available to the Razor Page. The model is used in the @Html.DisplayNameFor and @Html.DisplayFor HTML Helpers on the page.
ViewData and layout
Consider the following code:
The preceding highlighted code is an example of Razor transitioning into C#. The { and } characters enclose a block of C# code.
The PageModel base class has a ViewData dictionary property that can be used to add data that you want to pass to a View. You add objects into the ViewData dictionary using a key/value pattern. In the preceding sample, the "Title" property is added to the ViewData dictionary.
::: moniker range="= aspnetcore-2.0"
The "Title" property is used in the Pages/Shared/_Layout.cshtml file. The following markup shows the first few lines of the Pages/Shared/_Layout.cshtml file.
::: moniker-end
::: moniker range=">= aspnetcore-2.1"
The "Title" property is used in the Pages/Shared/_Layout.cshtml file. The following markup shows the first few lines of the _Layout.cshtml file.
::: moniker-end
The line @*Markup removed for brevity.*@ is a Razor comment. Unlike HTML comments (<!-- -->), Razor comments are not sent to the client.
Run the app and test the links in the project (Home, About, Contact, Create, Edit, and Delete). Each page sets the title, which you can see in the browser tab. When you bookmark a page, the title is used for the bookmark. Pages/Index.cshtml and Pages/Movies/Index.cshtml currently have the same title, but you can modify them to have different values.
[!NOTE] You may not be able to enter decimal commas in the
Pricefield. To support jQuery validation for non-English locales that use a comma (",") for a decimal point, and non US-English date formats, you must take steps to globalize your app. This GitHub issue 4076 for instructions on adding decimal comma.
The Layout property is set in the Pages/_ViewStart.cshtml file:
The preceding markup sets the layout file to Pages/Shared/_Layout.cshtml for all Razor files under the Pages folder. See Layout for more information.
Update the layout
Change the <title> element in the Pages/Shared/_Layout.cshtml file to use a shorter string.
Find the following anchor element in the Pages/Shared/_Layout.cshtml file.
<a asp-page="/Index" class="navbar-brand">RazorPagesMovie</a>
Replace the preceding element with the following markup.
<a asp-page="/Movies/Index" class="navbar-brand">RpMovie</a>
The preceding anchor element is a Tag Helper. In this case, it's the Anchor Tag Helper. The asp-page="/Movies/Index" Tag Helper attribute and value creates a link to the /Movies/Index Razor Page.
Save your changes, and test the app by clicking on the RpMovie link. See the _Layout.cshtml file in GitHub.
The Create page model
Examine the Pages/Movies/Create.cshtml.cs page model:
::: moniker range="= aspnetcore-2.0"
::: moniker-end
::: moniker range=">= aspnetcore-2.1"
::: moniker-end
The OnGet method initializes any state needed for the page. The Create page doesn't have any state to initialize, so Page is returned. Later in the tutorial you see OnGet method initialize state. The Page method creates a PageResult object that renders the Create.cshtml page.
The Movie property uses the [BindProperty] attribute to opt-in to model binding. When the Create form posts the form values, the ASP.NET Core runtime binds the posted values to the Movie model.
The OnPostAsync method is run when the page posts form data:
If there are any model errors, the form is redisplayed, along with any form data posted. Most model errors can be caught on the client-side before the form is posted. An example of a model error is posting a value for the date field that cannot be converted to a date. We'll talk more about client-side validation and model validation later in the tutorial.
If there are no model errors, the data is saved, and the browser is redirected to the Index page.
The Create Razor Page
Examine the Pages/Movies/Create.cshtml Razor Page file: