In this article I will explain with an example, how to populate (bind) CheckBoxList from database using Entity Framework Code First Approach in ASP.Net MVC.
Configuring Database with Entity Framework Code First Approach
I have made use of the following table Hobbies with the schema as follows. HobbyId is an Auto-Increment (Identity) column.
I have already inserted few records in the table.
Note: You can download the database table SQL by clicking the download link below.
You will need to configure and connect to the existing database table using Entity Framework Code First Approach.
Below is the generated DbContext class.
using System;
using System.Data.Entity;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
public partial class CodeFirstDBContext : DbContext
{
public CodeFirstDBContext()
: base("name=CodeFirst")
{
}
public virtual DbSet<Hobby> Hobbies { get; set; }
protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
modelBuilder.Entity<Hobby>()
.Property(e => e.Hobby1)
.IsUnicode(false);
}
}
Controller
The Controller consists of following two Action methods.
Action method for handling GET operation
Inside this Action method, the records are fetched from the Hobbies table using Entity Framework Code First Approach and are copied into generic list of SelectListItem class.
Note: The SelectListItem class which is an in-built ASP.Net MVC class. It has all the properties needed for populating a CheckBoxList.
The Hobby is stored in the Text property while the HobbyId is stored in the Value property.
Finally, the generic list of SelectListItem class is returned to the View.
Action method for handling POST operation
This Action method handles the call made from the POST function from the View.
When the Form is submitted, the posted values are captured through the generic list of SelectListItem class object as parameter.
Finally, a loop is executed over the generic list of SelectListItem class object and the selected Hobbies are set into a ViewBag object which will be later displayed in View using JavaScript Alert Message Box.
public class HomeController : Controller
{
// GET: Home
public ActionResult Index()
{
using (CodeFirstDBContext context = new CodeFirstDBContext())
{
List<SelectListItem> hobbiesList = (from p in context.Hobbies
select new SelectListItem
{
Text = p.Hobby1,
Value = p.HobbyId.ToString()
}).ToList();
return View(hobbiesList);
}
}
[HttpPost]
public ActionResult Index(List<SelectListItem> items)
{
ViewBag.Message = "Selected Items:\\n";
foreach (SelectListItem item in items)
{
if (item.Selected)
{
ViewBag.Message += string.Format("{0}\\n", item.Text);
}
}
return View(items);
}
}
View
Inside the View, in the very first line Generic list of SelectListItem class is declared as Model for the View.
The View consists of an HTML Form which has been created using the Html.BeginForm method with the following parameters.
ActionName – Name of the Action. In this case the name is Index.
ControllerName – Name of the Controller. In this case the name is Home.
FormMethod – It specifies the Form Method i.e. GET or POST. In this case it will be set to POST.
Inside the Form, a loop is executed over the generic list of SelectListItem class objects and an HTML Table is generated consisting of a CheckBoxList, a Label and two HiddenField elements generated using the following HTML helper methods.
Html.CheckBoxFor – Creating CheckBox for the Model property.
Html.DisplayFor – Displaying the text for each CheckBox.
Html.HiddenFor – Create HTML hidden input element for the Model property.
Note: The HiddenFields are used for storing the Text and Value of the CheckBox for sending it back during Form Submission.
Also there is a Submit Button which when clicked, the Form gets submitted and the Model object is sent to the Controller.
Finally, the selected Hobbies are displayed using JavaScript Alert Message Box.
@model List<SelectListItem>
@{
Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width" />
<title>Index</title>
</head>
<body>
@using (Html.BeginForm("Index", "Home", FormMethod.Post))
{
<table>
@for (int i = 0; i < Model.Count(); i++)
{
<tr>
<td>
@Html.CheckBoxFor(m => m[i].Selected)
</td>
<td>
@Html.DisplayFor(m => m[i].Text)
@Html.HiddenFor(m => m[i].Value)
@Html.HiddenFor(m => m[i].Text)
</td>
</tr>
}
</table>
<br />
<input type="submit" value="Submit" />
}
@if (ViewBag.Message != null)
{
<script type="text/javascript">
window.onload = function () {
alert("@ViewBag.Message");
};
</script>
}
</body>
</html>
Screenshot
Downloads