Skip to content

Commit 2c1051f

Browse files
authored
Merge pull request #7 from SyncfusionExamples/1023281-readme
Task(1023281): Updated README content
2 parents 87358df + a9d0960 commit 2c1051f

1 file changed

Lines changed: 41 additions & 2 deletions

File tree

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
1-
# connecting-databases-to-aspnetmvc-grid
2-
A suite of projects that enable data binding and CRUD action handling in the Syncfusion aspnetmvc Grid from various databases using CustomAdaptor and UrlAdaptor.
1+
# Connecting Databases to Syncfusion ASP.NET MVC Grid
2+
3+
## Repository Description
4+
5+
A suite of projects that enable data binding and CRUD action handling in the Syncfusion ASP.NET MVC Grid from various databases using CustomAdaptor and UrlAdaptor.
6+
7+
## Overview
8+
9+
The **connecting-databases-to-aspnetmvc-grid** repository provides a collection of focused examples designed to help developers understand different data binding and integration patterns supported by the Syncfusion EJ2 ASP.NET MVC Grid. Each sample is organized by scenario, making it easier to explore and learn specific approaches without unnecessary complexity.
10+
11+
The samples primarily focus on connecting the Grid component with databases, adapters, and backend services commonly used in modern web applications. These examples are intended for developers who want practical references while building enterprise-grade applications using Syncfusion components.
12+
13+
## Prerequisites
14+
15+
To run this sample, ensure you have the following installed:
16+
17+
- Visual Studio with ASP.NET MVC support
18+
- .NET Framework compatible with ASP.NET MVC
19+
- A configured database (as referenced in the project)
20+
- Syncfusion ASP.NET MVC components
21+
22+
## Using UrlAdaptor
23+
24+
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 a UI component. It enables the remote binding of data to the Syncfusion Angular 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), and [Web Method](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/web-method-adaptor), the `UrlAdaptor` is particularly useful for 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 is returned in the `result` and `count` format for display in the Grid.
25+
26+
## Using CustomAdaptor
27+
28+
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 Angular 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 later part of the documentation.
29+
30+
## Running the Application
31+
32+
1. Clone or download the repository.
33+
2. Open the solution file in Visual Studio.
34+
3. Restore NuGet packages if required.
35+
4. Update the database connection string in the configuration file.
36+
5. Build and run the application
37+
38+
## Resources
39+
40+
- https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/url-adaptor
41+
- https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/custom-adaptor

0 commit comments

Comments
 (0)