diff --git a/ej2-asp-core-mvc/grid/EJ2_ASP.MVC/connecting-to-database/entity-framework.md b/ej2-asp-core-mvc/grid/EJ2_ASP.MVC/connecting-to-database/entity-framework.md new file mode 100644 index 0000000000..e5746d38b2 --- /dev/null +++ b/ej2-asp-core-mvc/grid/EJ2_ASP.MVC/connecting-to-database/entity-framework.md @@ -0,0 +1,1885 @@ +--- +layout: post +title: Bind SQL Server Data in Syncfusion ##Platform_Name## Grid using Entity Framework +description: Learn about consume data using Entity Framework from Microsoft SQL Server, bind it to Syncfusion ##Platform_Name## Grid, and performing CRUD operations. +control: grid +platform: ej2-asp-core-mvc +keywords: adaptors, urladaptor, customadaptor, remotedata, entityframework +documentation: ug +domainurl: ##DomainURL## +--- + +# Connecting SQL Server data to Syncfusion ASP.NET MVC Grid using Entity Framework + +This section describes how to connect and retrieve data from a Microsoft SQL Server database using [Entity Framework](https://learn.microsoft.com/en-us/ef/core/) and bind it to the Syncfusion ASP.NET MVC Grid. + +Microsoft SQL Server database can be bound to the Grid using **Entity Framework** in different ways (i.e.) using [DataSource](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_DataSource) property, custom adaptor and remote data binding using various adaptors. In this documentation, two approaches will be examined to connect a Microsoft SQL Server database to a Grid using **Entity Framework**. Both the approaches have capability to handle data and CRUD operations with built-in methods as well as can be customized as per your own. + +**Entity Framework** + +Entity Framework is an open-source [ORM framework](https://en.wikipedia.org/wiki/Object-relational_mapping) for .NET applications supported by Microsoft. It enables developers to work with data using objects of domain specific classes without focusing on the underlying database tables and columns where this data is stored. With the Entity Framework, developers can work at a higher level of abstraction when they deal with data, and can create and maintain data-oriented applications with less code compared with traditional applications. + +**1. Using UrlAdaptor** + +The [UrlAdaptor](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/url-adaptor) serves as the base adaptor for facilitating communication between remote data services and an UI component. It enables the remote binding of data to the Syncfusion ASP.NET MVC Grid by connecting to an existing pre-configured API service linked to the Microsoft SQL Server database. While the Grid supports various adaptors to fulfill this requirement, including [Web API](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/web-api-adaptor), [ODataV4](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/odatav4-adaptor), [UrlAdaptor](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/url-adaptor), [Web Method](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/web-method-adaptor), and `GraphQL`, the `UrlAdaptor` is particularly useful for the scenarios where a custom API service with unique logic for handling data and CRUD operations is in place. This approach allows for custom handling of data and CRUD operations, and the resultant data returned in the `result` and `count` format for display in the Grid. + +**2. Using CustomAdaptor** + +The [CustomAdaptor](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/custom-adaptor) serves as a mediator between the UI component and the database for data binding. While the data source from the database can be directly bound to the Syncfusion ASP.NET MVC Grid locally using the `DataSource` property, the `CustomAdaptor` approach is preferred as it allows for customization of both data operations and CRUD operations according to specific requirements. In this approach, for every action in the Grid, a corresponding request with action details is sent to the `CustomAdaptor`. The Grid provides predefined methods to perform data operations such as **searching**, **filtering**, **sorting**, **aggregation**, **paging** and **grouping**. Alternatively, your own custom methods can be employed to execute operations and return the data in the `result` and `count` format for displaying in the Grid. Additionally, for CRUD operations, predefined methods can be overridden to provide custom functionality. Further details on this can be found in the latter part of the documentation. + +## Binding data using Entity Framework from Microsoft SQL Server via an API service. + +This section describes step by step process how to use Entity Framework to retrieve data from a Microsoft SQL Server using an API service and bind it to the Syncfusion ASP.NET MVC Grid. + +**1.** Open Visual Studio and create an ASP.NET MVC project named **Grid_EntityFramework**. To create an ASP.NET MVC application, follow the documentation [link](https://learn.microsoft.com/en-us/aspnet/mvc/overview/getting-started/introduction/getting-started#create-your-first-app) for detailed steps. + +**2.** To use **Entity Framework** and access the **Microsoft SQL Server** database in an ASP.NET MVC application, install the [Entity Framework](https://www.nuget.org/packages/EntityFramework) package. + +- Open **NuGet Package Manager** in Visual Studio (**Tools → NuGet Package Manager → Manage NuGet Packages for Solution**). +- Search for **EntityFramework** and install it. + +Alternatively, you can install it using the **Package Manager Console** with the following commands: + +```powershell +Install-Package EntityFramework +``` + +**3.** Create a MVC controller (aka, GridController.cs) file under **Controllers** folder that helps to establish data communication with the Grid. + +**4** In the MVC controller (aka, GridController), a connection is established to Microsoft SQL Server within the **GetOrderData()** method using **OrderDbContext**. This class extends **DbContext** and is configured to connect to a Microsoft SQL Server database using the provided connection string. It includes a **DbSet<Orders>** property, enabling interaction with the **Orders** table in the database. The method retrieves all orders from the database asynchronously and returns them as a list of `Orders` objects as shown in the following code snippet. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +using System; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Data.Entity; +using System.Linq; +using System.Web.Mvc; +using Syncfusion.EJ2.Base; + +namespace Grid_EntityFramework.Controllers +{ + public class GridController : Controller + { + string ConnectionString = @""; + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object along with the total record count. + public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) + { + using (var Context = new OrderDbContext()) + { + // Retrieve data from the database. + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data as JSON response. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } + } + + /// + /// Entity Framework DbContext for managing orders table in the database. + /// + public class OrderDbContext : DbContext + { + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } + } + + public class Orders + { + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } + } + } +} + +{% endhighlight %} +{% endtabs %} + +**5.** Run the application and it will be hosted within the URL `https://localhost:xxxx`. + +**6.** Finally, the retrieved data from Microsoft SQL Server database using Entity Framework which is in the form of list can be found in an API controller available in the URL link `https://localhost:xxxx/Grid/UrlDataSource`, as shown in the browser page below. + +![Hosted API URL](../images/database/db-data.png) + +### Connecting Syncfusion ASP.NET MVC Grid to an API Service + +To integrate the Syncfusion Grid into your ASP.NET MVC project using Visual Studio, follow these steps: + +**Step 1:** Install the Syncfusion ASP.NET MVC Package: + +To add `ASP.NET MVC` in the application, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for [Syncfusion.EJ2.MVC5](https://www.nuget.org/packages/Syncfusion.EJ2.MVC5) and install it. +Alternatively, you can install it using the following Package Manager Console command: + +{% tabs %} +{% highlight C# tabtitle="Package Manager" %} + +Install-Package Syncfusion.EJ2.MVC5 -Version {{ site.releaseversion }} + +{% endhighlight %} +{% endtabs %} + +**Step 2:** Add Syncfusion ASP.NET MVC namespace + +Add `Syncfusion.EJ2` namespace reference in `Web.config` under `Views` folder. + +```cs + + + +``` + +**Step 3:** Add stylesheet and script resources + +To include the required styles and scripts, add the following references inside the `` of `~/Pages/Shared/_Layout.cshtml` file: +{% tabs %} +{% highlight cshtml tabtitle="~/_Layout.cshtml" %} + + + ... + + + + + + + + + + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +**Step 4:** Register Syncfusion Script Manager + +To ensure proper script execution, register the Syncfusion Script Manager `EJS().ScriptManager()` at the end of `` in the `~/Pages/Shared/_Layout.cshtml` file as follows. + +{% tabs %} +{% highlight cshtml tabtitle="~/_Layout.cshtml" %} + + +... + + @Html.EJS().ScriptManager() + + +{% endhighlight %} +{% endtabs %} + +**Step 5:** Add the Syncfusion ASP.NET MVC Grid + +Now, add the Syncfusion ASP.NET MVC Grid tag helper in `~/Views/Home/Index.cshtml` file. This allows the Grid to be rendered and interact with data dynamically from a remote database. + +* Create a `DataManager` instance specifying the URL of your API endpoint(https:localhost:xxxx/Grid/UrlDataSource) using the `url` property and set the `adaptor` UrlAdaptor. + +* The `DataManager` offers multiple adaptor options to connect with remote database based on an API service. Below is an example of the `UrlAdaptor` configuration where an API service are set up to return the resulting data in the `result` and `count` format. + +* The `UrlAdaptor` acts as the base adaptor for interacting with remote data service. Most of the built-in adaptors are derived from the `UrlAdaptor`. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual port number +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/Grid/UrlDataSource").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Render() + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +using System; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Data.Entity; +using System.Linq; +using System.Web.Mvc; +using Syncfusion.EJ2.Base; + +namespace Grid_EntityFramework.Controllers +{ + public class GridController : Controller + { + string ConnectionString = @""; + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object along with the total record count. + public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) + { + using (var Context = new OrderDbContext()) + { + // Retrieve data from the database. + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data as JSON response. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } + } + + /// + /// Entity Framework DbContext for managing orders table in the database. + /// + public class OrderDbContext : DbContext + { + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } + } + + public class Orders + { + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } + } + } +} + +{% endhighlight %} +{% endtabs %} + +**Step 7:** Run the Project + +Run the project in Visual Studio, and the Syncfusion ASP.NET MVC Grid will successfully fetch data from the API service. + +> * The Syncfusion ASP.NET MVC Grid provides built-in support for handling various data operations such as searching, sorting, filtering, aggregate and paging on the server-side. These operations can be handled using methods such as `PerformSearching`, `PerformFiltering`, `PerformSorting`, `PerformTake` and `PerformSkip` available in the [Syncfusion.EJ2.MVC5](https://www.nuget.org/packages/Syncfusion.EJ2.MVC5) package. Let’s explore how to manage these data operations using the `UrlAdaptor`. +> * In an API service project, add `Syncfusion.EJ2.MVC5` by opening the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search and install it. +> * To access `DataManagerRequest`, import [Syncfusion.EJ2.Base](https://www.npmjs.com/package/@syncfusion/ej2-base) in `GridController.cs` file. + +### Handling searching operation + +To handle searching operation, ensure that your API endpoint supports custom searching criteria. Implement the searching logic on the server-side using the `PerformSearching` method from the `QueryableOperation` class. This allows the custom data source to undergo searching based on the criteria specified in the incoming `DataManagerRequest` object. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform searching operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the searched data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling searching operation. + if (DataManagerRequest.Search != null && DataManagerRequest.Search.Count > 0) + { + DataSource = queryableOperation.PerformSearching(DataSource, DataManagerRequest.Search); + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/Grid/UrlDatasource").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Toolbar(new List() { "Search" }).Render() + +{% endhighlight %} +{% endtabs %} + +### Handling filtering operation + +To handle filtering operation, ensure that your API endpoint supports custom filtering criteria. Implement the filtering logic on the server-side using the `PerformFiltering` method from the `QueryableOperation` class. This allows the custom data source to undergo filtering based on the criteria specified in the incoming `DataManagerRequest` object. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform filtering operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the filtered data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling filtering operation. + if (DataManagerRequest.Where != null && DataManagerRequest.Where.Count > 0) + { + foreach (WhereFilter condition in DataManagerRequest.Where) + { + foreach (WhereFilter predicate in condition.predicates) + { + DataSource = queryableOperation.PerformFiltering(DataSource, DataManagerRequest.Where, predicate.Operator); + } + } + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/Grid/UrlDatasource").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowFiltering().Render() + +{% endhighlight %} +{% endtabs %} + +### Handling sorting operation + +To handle sorting operation, ensure that your API endpoint supports custom sorting criteria. Implement the sorting logic on the server-side using the `PerformSorting` method from the `QueryableOperation` class. This allows the custom data source to undergo sorting based on the criteria specified in the incoming `DataManagerRequest` object. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform sorting operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the sorted data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling sorting operation. + if (DataManagerRequest.Sorted != null && DataManagerRequest.Sorted.Count > 0) + { + DataSource = queryableOperation.PerformSorting(DataSource, DataManagerRequest.Sorted); + } + else + { + // Default sorting by OrderID to prevent Skip error + DataSource = DataSource.OrderBy(o => o.OrderID); + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/Grid/UrlDatasource").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowSorting().Render() + +{% endhighlight %} +{% endtabs %} + +### Handling paging operation + +To handle paging operation, ensure that your API endpoint supports custom paging criteria. Implement the paging logic on the server-side using the `PerformTake` and `PerformSkip` method from the `QueryableOperation` class. This allows the custom data source to undergo paging based on the criteria specified in the incoming `DataManagerRequest` object. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform paging operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the paginated data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling sorting operation. + if (DataManagerRequest.Sorted != null && DataManagerRequest.Sorted.Count > 0) + { + DataSource = queryableOperation.PerformSorting(DataSource, DataManagerRequest.Sorted); + } + else + { + // Default sorting by OrderID to prevent Skip error + DataSource = DataSource.OrderBy(o => o.OrderID); + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Handling paging operation. + if (DataManagerRequest.Skip != 0) + { + DataSource = queryableOperation.PerformSkip(DataSource, DataManagerRequest.Skip); + } + + if (DataManagerRequest.Take != 0) + { + DataSource = queryableOperation.PerformTake(DataSource, DataManagerRequest.Take); + } + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/Grid/UrlDatasource").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowPaging().Render() + +{% endhighlight %} +{% endtabs %} + +### Handling CRUD operations + +The Syncfusion ASP.NET MVC Grid seamlessly integrates CRUD (Create, Read, Update and Delete) operations with server-side controller actions through specific properties: `InsertUrl`, `RemoveUrl`, `UpdateUrl`, and `BatchUrl`. These properties enable the Grid to communicate with the data service for every Grid action, facilitating server-side operations. + +**CRUD operations mapping** + +CRUD operations within the Grid can be mapped to server-side controller actions using specific properties: + +1. **InsertUrl**: Specifies the URL for inserting new data. +2. **RemoveUrl**: Specifies the URL for removing existing data. +3. **UpdateUrl**: Specifies the URL for updating existing data. +4. **BatchUrl**: Specifies the URL for batch editing. + +To enable editing in ASP.NET MVC Grid, refer to the editing [documentation](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/editing/edit). In the below example, the inline edit `Mode` is enabled and [Toolbar](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.Grid.html#Syncfusion_EJ2_Grids_Grid_Toolbar) property is configured to display toolbar items for editing purposes. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/Grid/UrlDatasource") + .UpdateUrl("https://localhost:xxxx/Grid/Update") + .InsertUrl("https://localhost:xxxx/Grid/Insert") + .RemoveUrl("https://localhost:xxxx/Grid/Remove").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Normal); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + +{% endhighlight %} +{% endtabs %} + +> * Normal/Inline editing is the default edit `Mode` for the Grid. To enable CRUD operations, ensure that the [IsPrimaryKey](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_IsPrimaryKey) property is set to **true** for a specific Grid column, ensuring that its value is unique. +> * If database has an auto generated column, ensure to define [IsIdentity](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_IsIdentity) property of Grid column to disable them during adding or editing operations. + +**Insert operation:** + +To insert a new row, simply click the **Add** toolbar button. The new record edit form will be displayed as shown below. Upon clicking the **Update** toolbar button, record will inserted into the **Orders** table by calling the following **POST** method of an API. Utilizing `Entity Framework` simplifies database tasks by managing database connections and queries through object-oriented programming, making it easier to work with databases in C# code, as shown in the following code snippet. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Inserts a new data item into the data collection. +/// +/// It contains the new record detail which is need to be inserted. +/// Returns a JSON result indicating success or failure. +public JsonResult Insert(Orders value) +{ + if (value == null) + { + return Json(new { success = false, message = "Inserted entity cannot be null." }); + } + + using (var Context = new OrderDbContext()) + { + // Add the provided order to the orders DbSet. + Context.Orders.Add(value); + + // Save changes to the database. + Context.SaveChanges(); + } + + return Json(new { success = true, message = "Insert successful", data = value }); +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +public class Orders +{ + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Update operation:** + +To edit a row, first select desired row and click the **Edit** toolbar button. The edit form will be displayed and proceed to modify any column value as per your requirement. Clicking the **Update** toolbar button will update the edit record in the **Orders** table by involving the following **Post** method of an API. Utilizing `Entity Framework` simplifies database tasks by managing database connections and queries through object-oriented programming, making it easier to work with databases in C# code, as shown in the following code snippet. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Update a existing data item from the data collection. +/// +/// It contains the updated record detail which is need to be updated. +/// Returns void. +public void Update(Orders value) +{ + using (var Context = new OrderDbContext()) + { + Orders existingOrder = Context.Orders.Find(value.OrderID); + if (existingOrder != null) + { + // Update the existing order with the new values. + Context.Entry(existingOrder).CurrentValues.SetValues(value); + + // Save changes to the database. + Context.SaveChanges(); + } + } + + //Add custom logic here if needed and remove above method. +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +public class Orders +{ + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Delete operation:** + +To delete a row, simply select the desired row and click the **Delete** toolbar button. This action will trigger a **DELETE** request to an API, containing the primary key value of the selected record. As a result corresponding record will be removed from the **Orders** table. Utilizing `Entity Framework` simplifies database tasks by managing database connections and queries through object-oriented programming, making it easier to work with databases in C# code, as shown in the following code snippet. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Remove a specific data item from the data collection. +/// +/// It contains the specific record detail which is need to be removed. +/// Returns void. +public void Remove(CRUDModel value) +{ + int OrderId = Convert.ToInt32(value.key.ToString()); + using (var Context = new OrderDbContext()) + { + Orders Order = Context.Orders.Find(OrderId); + if (Order != null) + { + // Remove the order from the orders DbSet. + Context.Orders.Remove(Order); + + // Save changes to the database. + Context.SaveChanges(); + } + } + + //Add custom logic here if needed and remove above method. +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +public class CRUDModel where T : class +{ + public string action { get; set; } + public string keyColumn { get; set; } + public object key { get; set; } + public T value { get; set; } + public List added { get; set; } + public List changed { get; set; } + public List deleted { get; set; } + public IDictionary @params { get; set; } +} + +public class Orders +{ + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Batch operation:** + +To perform batch operation, define the edit `Mode` as **Batch** and specify the `batchUrl` property in the `DataManager`. Use the **Add** toolbar button to insert new row in batch editing mode. To edit a cell, double-click the desired cell and update the value as required. To delete a record, simply select the record and press the **Delete** toolbar button. Now, all CRUD operations will be executed in batch editing mode. Clicking the **Update** toolbar button will update the newly added, edited, or deleted records from the **Orders** table using a single API **POST** request. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Batch update (Insert, Update, and Delete) a collection of data items from the data collection. +/// +/// The set of information along with details about the CRUD actions to be executed from the database. +/// Returns a JsonResult containing the processed data. +public JsonResult BatchUpdate(CRUDModel value) +{ + using (var Context = new OrderDbContext()) + { + // Handle changed records. + if (value.changed != null && value.changed.Count > 0) + { + foreach (Orders Record in value.changed) + { + // Update the changed records. + Context.Orders.Attach(Record); + Context.Entry(Record).State = EntityState.Modified; + } + } + + // Handle added records. + if (value.added != null && value.added.Count > 0) + { + foreach (Orders order in value.added) + { + // This ensures EF does not try to insert OrderID. + order.OrderID = default; + + // Add new records. + Context.Orders.Add(order); + } + } + + // Handle deleted records. + if (value.deleted != null && value.deleted.Count > 0) + { + foreach (Orders Record in value.deleted) + { + // Find and delete the records. + var existingOrder = Context.Orders.Find(Record.OrderID); + if (existingOrder != null) + { + Context.Orders.Remove(existingOrder); + } + } + } + + // Save all changes to the database. + Context.SaveChanges(); + } + return Json(value, JsonRequestBehavior.AllowGet); +} + +public class CRUDModel where T : class +{ + public string action { get; set; } + public string keyColumn { get; set; } + public object key { get; set; } + public T value { get; set; } + public List added { get; set; } + public List changed { get; set; } + public List deleted { get; set; } + public IDictionary @params { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/Grid/UrlDatasource").BatchUrl("https://localhost:xxxx/Grid/BatchUpdate").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).AllowPaging().EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Batch); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + +{% endhighlight %} +{% endtabs %} + +When you run the application, the resultant Grid will look like this + +![Syncfusion ASP.NET MVC Grid bound with Microsoft SQL Server data using Entity Framework](../images/database/db-crud.gif) + +## Binding data from Microsoft SQL Server using Entity Framework with CustomAdaptor + +This section describes step by step process how to retrieve data from a Microsoft SQL Server using [CustomAdaptor](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/custom-adaptor) and bind it to the Syncfusion ASP.NET MVC Grid. + +**1.** To create a simple Grid, the procedure is explained in the above-mentioned topic on [Connecting Syncfusion ASP.NET MVC Grid to an API service](##connecting-syncfusion-aspnet-mvc-grid-to-an-api-service) + +**2.** To use **Entity Framework** and access the **Microsoft SQL Server** database in an ASP.NET MVC application, install the [Entity Framework](https://www.nuget.org/packages/EntityFramework) package. + +- Open **NuGet Package Manager** in Visual Studio (**Tools → NuGet Package Manager → Manage NuGet Packages for Solution**). +- Search for **EntityFramework** and install it. + +Alternatively, you can install it using the **Package Manager Console** with the following commands: + +```powershell +Install-Package EntityFramework +``` + +**3.** If you intend to inject your own service into the `CustomAdaptor` and utilize it, you can achieve this as follows: + + * Create a `CustomAdaptor` that extends the `UrlAdaptor` class. + * Override the `processResponse` method to process server responses. + +**4.** Within the `processResponse` method of `CustomAdaptor`, fetch data by calling the **GetOrderData** method. + + * In this **GetOrderData** method, a connection is established to Microsoft SQL Server using **OrderDbContext**. This class extends **DbContext** and is configured to connect to a SQL Server database using the provided connection string. It includes a **DbSet** property, enabling interaction with the **Orders** table in the database. The method retrieves all orders from the database asynchronously and returns them as a list of `Orders` objects. + + * Finally, return the response as a **result** and **count** pair object in the `processResponse` method to bind the data to the Grid. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Render() + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +using System; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Data.Entity; +using System.Linq; +using System.Web.Mvc; +using Syncfusion.EJ2.Base; + +namespace Grid_EntityFramework.Controllers +{ + public class GridController : Controller + { + string ConnectionString = @""; + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object along with the total record count. + public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) + { + using (var Context = new OrderDbContext()) + { + // Retrieve data from the database. + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data as JSON response. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } + } + + /// + /// Entity Framework DbContext for managing orders table in the database. + /// + public class OrderDbContext : DbContext + { + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } + } + + public class Orders + { + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } + } + } +} + +{% endhighlight %} +{% endtabs %} + +> * The `DataManagerRequest` encompasses details about the Grid actions such as searching, filtering, sorting, aggregate, paging and grouping. + +### Handling searching operation + +When utilizing the `CustomAdaptor` in ASP.NET MVC, managing the searching operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, searching a custom data source can be accomplished by employing the built-in `PerformSearching` method of the `QueryableOperation` class. Alternatively, you can implement your own method for searching operation and bind the resultant data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform searching operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the searched data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling searching operation. + if (DataManagerRequest.Search != null && DataManagerRequest.Search.Count > 0) + { + DataSource = queryableOperation.PerformSearching(DataSource, DataManagerRequest.Search); + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Toolbar(new List() { "Search" }).Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling filtering operation + +When utilizing the `CustomAdaptor` in ASP.NET MVC, managing the filtering operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, filtering a custom data source can be achieved by utilizing the built-in `PerformFiltering` method of the `QueryableOperation` class. Alternatively, you can implement your own method for filtering operation and bind the resulting data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform filtering operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the filtered data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling filtering operation. + if (DataManagerRequest.Where != null && DataManagerRequest.Where.Count > 0) + { + foreach (WhereFilter condition in DataManagerRequest.Where) + { + foreach (WhereFilter predicate in condition.predicates) + { + DataSource = queryableOperation.PerformFiltering(DataSource, DataManagerRequest.Where, predicate.Operator); + } + } + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowFiltering().Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling sorting operation + +When utilizing the `CustomAdaptor` in ASP.NET MVC, managing the sorting operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, sorting a custom data source can be accomplished by employing the built-in `PerformSorting` method of the `QueryableOperation` class. Alternatively, you can implement your own method for sorting operation and bind the resulting data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform sorting operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the sorted data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling sorting operation. + if (DataManagerRequest.Sorted != null && DataManagerRequest.Sorted.Count > 0) + { + DataSource = queryableOperation.PerformSorting(DataSource, DataManagerRequest.Sorted); + } + else + { + // Default sorting by OrderID to prevent Skip error + DataSource = DataSource.OrderBy(o => o.OrderID); + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowSorting().Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling paging operation + +When utilizing the `CustomAdaptor` in ASP.NET MVC, managing the paging operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, paging a custom data source can be achieved by utilizing the built-in `PerformTake` and `PerformSkip` method of the `QueryableOperation` class. Alternatively, you can use your own method for paging operation and bind the resulting data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform paging operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the paginated data along with the total record count. +public JsonResult UrlDataSource(DataManagerRequest DataManagerRequest) +{ + using (var Context = new OrderDbContext()) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = Context.Orders.AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling sorting operation. + if (DataManagerRequest.Sorted != null && DataManagerRequest.Sorted.Count > 0) + { + DataSource = queryableOperation.PerformSorting(DataSource, DataManagerRequest.Sorted); + } + else + { + // Default sorting by OrderID to prevent Skip error + DataSource = DataSource.OrderBy(o => o.OrderID); + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Handling paging operation. + if (DataManagerRequest.Skip != 0) + { + DataSource = queryableOperation.PerformSkip(DataSource, DataManagerRequest.Skip); + } + + if (DataManagerRequest.Take != 0) + { + DataSource = queryableOperation.PerformTake(DataSource, DataManagerRequest.Take); + } + + // Return data based on the request. + return Json(new { result = DataSource.ToList(), count = totalRecordsCount }, JsonRequestBehavior.AllowGet); + } +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowPaging().Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling CRUD operations + +To enable editing in the Syncfusion ASP.NET MVC Grid, utilize the [GridEditSettings](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridEditSettings.html) property. The Grid offers multiple edit modes including the **Inline/Normal**, **Dialog** and **Batch** editing. For more details, refer to the Grid [editing](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/editing/edit) documentation. + +In this scenario, the inline edit `Mode` and [Toolbar](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.Grid.html#Syncfusion_EJ2_Grids_Grid_Toolbar) property configured to display toolbar items for editing purpose. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Normal); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + + + +{% endhighlight %} +{% endtabs %} + +> * Normal/Inline editing is the default edit `Mode` for the Grid. To enable CRUD operations, ensure that the [IsPrimaryKey](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_IsPrimaryKey) property is set to **true** for a specific Grid column, ensuring that its value is unique. +> * If database has an auto generated column, ensure to define [IsIdentity](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_IsIdentity) property of Grid column to disable them during adding or editing operations. + +The CRUD operations can be performed and customized on our own by overriding the following CRUD methods of the `UrlAdaptor` + +* insert +* remove +* update +* batchRequest + +Let’s see how to perform CRUD operations using Entity Framework in Microsoft SQL Server data with Syncfusion Grid. + +**Insert operation:** + +To execute the insert operation, you will need to override the `insert` method of the `CustomAdaptor`. Then, integrate the following code snippet into the `CustomAdaptor` class. The below code snippet demonstrated how to handle the insertion of new records within the `insert` method of `CustomAdaptor` . Modify the logic within this method according to the requirements of your application. Utilizing `Entity Framework` simplifies database tasks by managing database connections and queries through object-oriented programming, making it easier to work with databases in C# code, as shown in the following code snippet. + +{% tabs%} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Inserts a new data item into the data collection. +/// +/// It contains the new record detail which is need to be inserted. +/// Returns a JSON result indicating success or failure. +public JsonResult Insert(Orders value) +{ + if (value == null) + { + return Json(new { success = false, message = "Inserted entity cannot be null." }); + } + + using (var Context = new OrderDbContext()) + { + // Add the provided order to the orders DbSet. + Context.Orders.Add(value); + + // Save changes to the database. + Context.SaveChanges(); + } + + return Json(new { success = true, message = "Insert successful", data = value }); +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +public class Orders +{ + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Update operation:** + +To execute the update operation, override the `update` method of the `CustomAdaptor`. Then, integrate the following code snippet into the `CustomAdaptor` class. The below code snippet demonstrated how to handle the updating of existing records within the `update` method of the `CustomAdaptor`. Modify the logic within this method according to the requirements of your application. Utilizing `Entity Framework` simplifies database tasks by managing database connections and queries through object-oriented programming, making it easier to work with databases in C# code, as shown in the following code snippet. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Update a existing data item from the data collection. +/// +/// It contains the updated record detail which is need to be updated. +/// Returns void. +public void Update(Orders value) +{ + using (var Context = new OrderDbContext()) + { + Orders existingOrder = Context.Orders.Find(value.OrderID); + if (existingOrder != null) + { + // Update the existing order with the new values. + Context.Entry(existingOrder).CurrentValues.SetValues(value); + + // Save changes to the database. + Context.SaveChanges(); + } + } + + //Add custom logic here if needed and remove above method. +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +public class Orders +{ + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Delete operation:** + +To perform the delete operation, you need to override the `remove` method of the `CustomAdaptor`. Below is the code snippet that you can add to `CustomAdaptor` class. The below code snippet demonstrated how to handle the deletion of existing records within the `remove` method of `CustomAdaptor`. Modify the logic within this method according to the requirements of your application. Utilizing `Entity Framework` simplifies database tasks by managing database connections and queries through object-oriented programming, making it easier to work with databases in C# code, as shown in the following code snippet. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Remove a specific data item from the data collection. +/// +/// It contains the specific record detail which is need to be removed. +/// Returns void. +public void Remove(CRUDModel value) +{ + int OrderId = Convert.ToInt32(value.key.ToString()); + using (var Context = new OrderDbContext()) + { + Orders Order = Context.Orders.Find(OrderId); + if (Order != null) + { + // Remove the order from the orders DbSet. + Context.Orders.Remove(Order); + + // Save changes to the database. + Context.SaveChanges(); + } + } + + //Add custom logic here if needed and remove above method. +} + +/// +/// Entity Framework DbContext for managing orders table in the database. +/// +public class OrderDbContext : DbContext +{ + // Initializes a new instance of OrderDbContext and configures the database connection. + public OrderDbContext(): base(ConnectionString){} + + // Represents the orders table in the database. + public DbSet Orders { get; set; } +} + +public class CRUDModel where T : class +{ + public string action { get; set; } + public string keyColumn { get; set; } + public object key { get; set; } + public T value { get; set; } + public List added { get; set; } + public List changed { get; set; } + public List deleted { get; set; } + public IDictionary @params { get; set; } +} + +public class Orders +{ + [Key] + public int OrderID { get; set; } + public string CustomerID { get; set; } + public int EmployeeID { get; set; } + public decimal Freight { get; set; } + public string ShipCity { get; set; } + public string ShipName { get; set; } + public string ShipCountry { get; set; } + public string ShipAddress { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Batch operation:** + +To perform the batch operation, override the `batchRequest` method of the `CustomAdaptor` and add the following code in the `CustomAdaptor`. The below code snippet demonstrated how to handle the batch update request within the `batchRequest` method of `CustomAdaptor`. Modify the logic within this method according to the requirements of your application. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).AllowPaging().EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Batch); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Batch update (Insert, Update, and Delete) a collection of data items from the data collection. +/// +/// The set of information along with details about the CRUD actions to be executed from the database. +/// Returns a JsonResult containing the processed data. +public JsonResult BatchUpdate(CRUDModel value) +{ + using (var Context = new OrderDbContext()) + { + // Handle changed records. + if (value.changed != null && value.changed.Count > 0) + { + foreach (Orders Record in value.changed) + { + // Update the changed records. + Context.Orders.Attach(Record); + Context.Entry(Record).State = EntityState.Modified; + } + } + + // Handle added records. + if (value.added != null && value.added.Count > 0) + { + foreach (Orders order in value.added) + { + // This ensures EF does not try to insert OrderID. + order.OrderID = default; + + // Add new records. + Context.Orders.Add(order); + } + } + + // Handle deleted records. + if (value.deleted != null && value.deleted.Count > 0) + { + foreach (Orders Record in value.deleted) + { + // Find and delete the records. + var existingOrder = Context.Orders.Find(Record.OrderID); + if (existingOrder != null) + { + Context.Orders.Remove(existingOrder); + } + } + } + + // Save all changes to the database. + Context.SaveChanges(); + } + return Json(value, JsonRequestBehavior.AllowGet); +} + +public class CRUDModel where T : class +{ + public string action { get; set; } + public string keyColumn { get; set; } + public object key { get; set; } + public T value { get; set; } + public List added { get; set; } + public List changed { get; set; } + public List deleted { get; set; } + public IDictionary @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +![Grid bound with Microsoft SQL server data using Entity Framework](../images/database/db-batch.gif) diff --git a/ej2-asp-mvc-toc.html b/ej2-asp-mvc-toc.html index 843829623f..829a213eb3 100644 --- a/ej2-asp-mvc-toc.html +++ b/ej2-asp-mvc-toc.html @@ -1261,8 +1261,9 @@
  • Connecting to Database
  • Data Annotation