Examining the Edit Methods and Edit View
[!INCLUDETutorial Note]
In this section, you’ll examine the generated Edit action methods and views for the movie controller. But first will take a short diversion to make the release date look better. Open the Models.cs file and add the highlighted lines shown below:
[!code-csharpMain]
1: using System;
2: using System.ComponentModel.DataAnnotations;
3: using System.Data.Entity;
4:
5: namespace MvcMovie.Models
6: {
7: public class Movie
8: {
9: public int ID { get; set; }
10: public string Title { get; set; }
11:
12: [Display(Name = "Release Date")]
13: [DataType(DataType.Date)]
14: [DisplayFormat(DataFormatString = "{0:yyyy-MM-dd}", ApplyFormatInEditMode = true)]
15: public DateTime ReleaseDate { get; set; }
16: public string Genre { get; set; }
17: public decimal Price { get; set; }
18: }
19:
20: public class MovieDBContext : DbContext
21: {
22: public DbSet<Movie> Movies { get; set; }
23: }
24: }
You can also make the date culture specific like this:
[!code-csharpMain]
1: [Display(Name = "Release Date")]
2: [DataType(DataType.Date)]
3: [DisplayFormat(DataFormatString = "{0:d}", ApplyFormatInEditMode = true)]
4: public DateTime ReleaseDate { get; set; }
We’ll cover DataAnnotations in the next tutorial. The Display attribute specifies what to display for the name of a field (in this case “Release Date” instead of “ReleaseDate”). The DataType attribute specifies the type of the data, in this case it’s a date, so the time information stored in the field is not displayed. The DisplayFormat attribute is needed for a bug in the Chrome browser that renders date formats incorrectly.
Run the application and browse to the Movies controller. Hold the mouse pointer over an Edit link to see the URL that it links to.
The Edit link was generated by the Html.ActionLink method in the Views.cshtml view:
[!code-cshtmlMain]
1: @Html.ActionLink("Edit", "Edit", new { id=item.ID })
The Html object is a helper that’s exposed using a property on the System.Web.Mvc.WebViewPage base class. The ActionLink method of the helper makes it easy to dynamically generate HTML hyperlinks that link to action methods on controllers. The first argument to the ActionLink method is the link text to render (for example, <a>Edit Me</a>). The second argument is the name of the action method to invoke (In this case, the Edit action). The final argument is an anonymous object that generates the route data (in this case, the ID of 4).
The generated link shown in the previous image is http://localhost:1234/Movies/Edit/4. The default route (established in App_Start.cs) takes the URL pattern {controller}/{action}/{id}. Therefore, ASP.NET translates http://localhost:1234/Movies/Edit/4 into a request to the Edit action method of the Movies controller with the parameter ID equal to 4. Examine the following code from the App_Start.cs file. The MapRoute method is used to route HTTP requests to the correct controller and action method and supply the optional ID parameter. The MapRoute method is also used by the HtmlHelpers such as ActionLink to generate URLs given the controller, action method and any route data.
[!code-csharpMain]
1: public static void RegisterRoutes(RouteCollection routes)
2: {
3: routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
4:
5: routes.MapRoute(
6: name: "Default",
7: url: "{controller}/{action}/{id}",
8: defaults: new { controller = "Home", action = "Index",
9: id = UrlParameter.Optional }
10: );
11: }
You can also pass action method parameters using a query string. For example, the URL http://localhost:1234/Movies/Edit?ID=3 also passes the parameter ID of 3 to the Edit action method of the Movies controller.
Open the Movies controller. The two Edit action methods are shown below.
[!code-csharpMain]
1: // GET: /Movies/Edit/5
2: public ActionResult Edit(int? id)
3: {
4: if (id == null)
5: {
6: return new HttpStatusCodeResult(HttpStatusCode.BadRequest);
7: }
8: Movie movie = db.Movies.Find(id);
9: if (movie == null)
10: {
11: return HttpNotFound();
12: }
13: return View(movie);
14: }
15:
16: // POST: /Movies/Edit/5
17: // To protect from overposting attacks, please enable the specific properties you want to bind to, for
18: // more details see http://go.microsoft.com/fwlink/?LinkId=317598.
19: [HttpPost]
20: [ValidateAntiForgeryToken]
21: public ActionResult Edit([Bind(Include="ID,Title,ReleaseDate,Genre,Price")] Movie movie)
22: {
23: if (ModelState.IsValid)
24: {
25: db.Entry(movie).State = EntityState.Modified;
26: db.SaveChanges();
27: return RedirectToAction("Index");
28: }
29: return View(movie);
30: }
Notice the second Edit action method is preceded by the HttpPost attribute. This attribute specifies that the overload of the Edit method can be invoked only for POST requests. You could apply the HttpGet attribute to the first edit method, but that’s not necessary because it’s the default. (We’ll refer to action methods that are implicitly assigned the HttpGet attribute as HttpGet methods.) The Bind attribute is another important security mechanism that keeps hackers from over-posting data to your model. You should only include properties in the bind attribute that you want to change. You can read about overposting and the bind attribute in my overposting security note. In the simple model used in this tutorial, we will be binding all the data in the model. The ValidateAntiForgeryToken attribute is used to prevent forgery of a request and is paired up with @Html.AntiForgeryToken() in the edit view file (Views.cshtml), a portion is shown below:
[!code-cshtmlMain]
1: @model MvcMovie.Models.Movie
2:
3: @{
4: ViewBag.Title = "Edit";
5: }
6: <h2>Edit</h2>
7: @using (Html.BeginForm())
8: {
9: @Html.AntiForgeryToken()
10: <div class="form-horizontal">
11: <h4>Movie</h4>
12: <hr />
13: @Html.ValidationSummary(true)
14: @Html.HiddenFor(model => model.ID)
15:
16: <div class="form-group">
17: @Html.LabelFor(model => model.Title, new { @class = "control-label col-md-2" })
18: <div class="col-md-10">
19: @Html.EditorFor(model => model.Title)
20: @Html.ValidationMessageFor(model => model.Title)
21: </div>
22: </div>
@Html.AntiForgeryToken() generates a hidden form anti-forgery token that must match in the Edit method of the Movies controller. You can read more about Cross-site request forgery (also known as XSRF or CSRF) in my tutorial XSRF/CSRF Prevention in MVC.
The HttpGet Edit method takes the movie ID parameter, looks up the movie using the Entity Framework Find method, and returns the selected movie to the Edit view. If a movie cannot be found, HttpNotFound is returned. When the scaffolding system created the Edit view, it examined the Movie class and created code to render <label> and <input> elements for each property of the class. The following example shows the Edit view that was generated by the visual studio scaffolding system:
[!code-cshtmlMain]
1: @model MvcMovie.Models.Movie
2:
3: @{
4: ViewBag.Title = "Edit";
5: }
6: <h2>Edit</h2>
7: @using (Html.BeginForm())
8: {
9: @Html.AntiForgeryToken()
10: <div class="form-horizontal">
11: <h4>Movie</h4>
12: <hr />
13: @Html.ValidationSummary(true)
14: @Html.HiddenFor(model => model.ID)
15:
16: <div class="form-group">
17: @Html.LabelFor(model => model.Title, new { @class = "control-label col-md-2" })
18: <div class="col-md-10">
19: @Html.EditorFor(model => model.Title)
20: @Html.ValidationMessageFor(model => model.Title)
21: </div>
22: </div>
23: <div class="form-group">
24: @Html.LabelFor(model => model.ReleaseDate, new { @class = "control-label col-md-2" })
25: <div class="col-md-10">
26: @Html.EditorFor(model => model.ReleaseDate)
27: @Html.ValidationMessageFor(model => model.ReleaseDate)
28: </div>
29: </div>
30: @*Genre and Price removed for brevity.*@
31: <div class="form-group">
32: <div class="col-md-offset-2 col-md-10">
33: <input type="submit" value="Save" class="btn btn-default" />
34: </div>
35: </div>
36: </div>
37: }
38: <div>
39: @Html.ActionLink("Back to List", "Index")
40: </div>
41: @section Scripts {
42: @Scripts.Render("~/bundles/jqueryval")
43: }
Notice how the view template has a @model MvcMovie.Models.Movie statement at the top of the file — this specifies that the view expects the model for the view template to be of type Movie.
The scaffolded code uses several helper methods to streamline the HTML markup. The Html.LabelFor helper displays the name of the field (“Title”, “ReleaseDate”, “Genre”, or “Price”). The Html.EditorFor helper renders an HTML <input> element. The Html.ValidationMessageFor helper displays any validation messages associated with that property.
Run the application and navigate to the /Movies URL. Click an Edit link. In the browser, view the source for the page. The HTML for the form element is shown below.
[!code-cshtmlMain]
1: <form action="/movies/Edit/4" method="post">
2: <input name="__RequestVerificationToken" type="hidden" value="UxY6bkQyJCXO3Kn5AXg-6TXxOj6yVBi9tghHaQ5Lq_qwKvcojNXEEfcbn-FGh_0vuw4tS_BRk7QQQHlJp8AP4_X4orVNoQnp2cd8kXhykS01" /> <fieldset class="form-horizontal">
3: <legend>Movie</legend>
4:
5: <input data-val="true" data-val-number="The field ID must be a number." data-val-required="The ID field is required." id="ID" name="ID" type="hidden" value="4" />
6:
7: <div class="control-group">
8: <label class="control-label" for="Title">Title</label>
9: <div class="controls">
10: <input class="text-box single-line" id="Title" name="Title" type="text" value="GhostBusters" />
11: <span class="field-validation-valid help-inline" data-valmsg-for="Title" data-valmsg-replace="true"></span>
12: </div>
13: </div>
14:
15: <div class="control-group">
16: <label class="control-label" for="ReleaseDate">Release Date</label>
17: <div class="controls">
18: <input class="text-box single-line" data-val="true" data-val-date="The field Release Date must be a date." data-val-required="The Release Date field is required." id="ReleaseDate" name="ReleaseDate" type="date" value="1/1/1984" />
19: <span class="field-validation-valid help-inline" data-valmsg-for="ReleaseDate" data-valmsg-replace="true"></span>
20: </div>
21: </div>
22:
23: <div class="control-group">
24: <label class="control-label" for="Genre">Genre</label>
25: <div class="controls">
26: <input class="text-box single-line" id="Genre" name="Genre" type="text" value="Comedy" />
27: <span class="field-validation-valid help-inline" data-valmsg-for="Genre" data-valmsg-replace="true"></span>
28: </div>
29: </div>
30:
31: <div class="control-group">
32: <label class="control-label" for="Price">Price</label>
33: <div class="controls">
34: <input class="text-box single-line" data-val="true" data-val-number="The field Price must be a number." data-val-required="The Price field is required." id="Price" name="Price" type="text" value="7.99" />
35: <span class="field-validation-valid help-inline" data-valmsg-for="Price" data-valmsg-replace="true"></span>
36: </div>
37: </div>
38:
39: <div class="form-actions no-color">
40: <input type="submit" value="Save" class="btn" />
41: </div>
42: </fieldset>
43: </form>
The <input> elements are in an HTML <form> element whose action attribute is set to post to the /Movies/Edit URL. The form data will be posted to the server when the Save button is clicked. The second line shows the hidden XSRF token generated by the @Html.AntiForgeryToken() call.
Processing the POST Request
The following listing shows the HttpPost version of the Edit action method.
[!code-csharpMain]
1: [HttpPost]
2: [ValidateAntiForgeryToken]
3: public ActionResult Edit([Bind(Include="ID,Title,ReleaseDate,Genre,Price")] Movie movie)
4: {
5: if (ModelState.IsValid)
6: {
7: db.Entry(movie).State = EntityState.Modified;
8: db.SaveChanges();
9: return RedirectToAction("Index");
10: }
11: return View(movie);
12: }
The ValidateAntiForgeryToken attribute validates the XSRF token generated by the @Html.AntiForgeryToken() call in the view.
The ASP.NET MVC model binder takes the posted form values and creates a Movie object that’s passed as the movie parameter. The ModelState.IsValid method verifies that the data submitted in the form can be used to modify (edit or update) a Movie object. If the data is valid, the movie data is saved to the Movies collection of the db(MovieDBContext instance). The new movie data is saved to the database by calling the SaveChanges method of MovieDBContext. After saving the data, the code redirects the user to the Index action method of the MoviesController class, which displays the movie collection, including the changes just made.
As soon as the client side validation determines the values of a field are not valid, an error message is displayed. If you disable JavaScript, you won’t have client side validation but the server will detect the posted values are not valid, and the form values will be redisplayed with error messages. Later in the tutorial we examine validation in more detail.
The Html.ValidationMessageFor helpers in the Edit.cshtml view template take care of displaying appropriate error messages.
All the HttpGet methods follow a similar pattern. They get a movie object (or list of objects, in the case of Index), and pass the model to the view. The Create method passes an empty movie object to the Create view. All the methods that create, edit, delete, or otherwise modify data do so in the HttpPost overload of the method. Modifying data in an HTTP GET method is a security risk, as described in the blog post entry ASP.NET MVC Tip #46 – Don’t use Delete Links because they create Security Holes. Modifying data in a GET method also violates HTTP best practices and the architectural REST pattern, which specifies that GET requests should not change the state of your application. In other words, performing a GET operation should be a safe operation that has no side effects and doesn’t modify your persisted data.
If you are using a US-English computer, you can skip this section and go to the next tutorial. You can download the Globalize version of this tutorial here. For an excellent two part tutorial on Internationalization, see Nadeem’s ASP.NET MVC 5 Internationalization.
[!NOTE] to support jQuery validation for non-English locales that use a comma (“,”) for a decimal point, and non US-English date formats, you must include globalize.js and your specific cultures/globalize.cultures.js file(from https://github.com/jquery/globalize ) and JavaScript to use
Globalize.parseFloat. You can get the jQuery non-English validation from NuGet. (Don’t install Globalize if you are using a English locale.)
From the Tools menu click NuGetLibrary Package Manager, and then click Manage NuGet Packages for Solution.
- On the left pane, select Browse.(See the image below.)
In the input box, enter *Globalize**.
Choose jQuery.Validation.Globalize, chooseMvcMovieand click Install. The Scripts.globalize.js file will be added to your project. The *Scripts.globalize* folder will contain many culture JavaScript files. Note, it may take five minutes to install this package.
The following code shows the modifications to the Views.cshtml file:
[!code-cshtmlMain]
1: @section Scripts {
2: @Scripts.Render("~/bundles/jqueryval")
3:
4: <script src="~/Scripts/globalize/globalize.js"></script>
5: <script src="~/Scripts/globalize/cultures/globalize.culture.@(System.Threading.Thread.CurrentThread.CurrentCulture.Name).js"></script>
6: <script>
7: $.validator.methods.number = function (value, element) {
8: return this.optional(element) ||
9: !isNaN(Globalize.parseFloat(value));
10: }
11: $(document).ready(function () {
12: Globalize.culture('@(System.Threading.Thread.CurrentThread.CurrentCulture.Name)');
13: });
14: </script>
15: <script>
16: jQuery.extend(jQuery.validator.methods, {
17: range: function (value, element, param) {
18: //Use the Globalization plugin to parse the value
19: var val = Globalize.parseFloat(value);
20: return this.optional(element) || (
21: val >= param[0] && val <= param[1]);
22: }
23: });
24: $.validator.methods.date = function (value, element) {
25: return this.optional(element) ||
26: Globalize.parseDate(value) ||
27: Globalize.parseDate(value, "yyyy-MM-dd");
28: }
29: </script>
30: }
To avoid repeating this code in every Edit view, you can move it to the layout file. To optimize the script download, see my tutorial Bundling and Minification.
For more information see ASP.NET MVC 3 Internationalization and ASP.NET MVC 3 Internationalization - Part 2 (NerdDinner).
As a temporary fix, if you can’t get validation working in your locale, you can force your computer to use US English or you can disable JavaScript in your browser. To force your computer to use US English, you can add the globalization element to the projects root web.config file. The following code shows the globalization element with the culture set to United States English.
[!code-xmlMain]
1: <system.web>
2: <globalization culture ="en-US" />
3: <!--elements removed for clarity-->
4: </system.web>
In the next tutorial, we’ll implement search functionality.
)
|
|