Skip to content

Commit 57dcc14

Browse files
992668: Updated the UG content and samples for Adaptors in Blazor DataGrid
1 parent 958776f commit 57dcc14

File tree

3 files changed

+16
-18
lines changed

3 files changed

+16
-18
lines changed

blazor/datagrid/connecting-to-adaptors/custom-adaptor.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ documentation: ug
1010

1111
# Custom Binding in Blazor DataGrid
1212

13-
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor DataGrid supports custom data operations through the [CustomAdaptor](https://blazor.syncfusion.com/documentation/data/custom-binding) in the [SfDataManager](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.SfDataManager.html). This adaptor allows complete control over data handling by overriding methods in the [DataAdaptor](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DataAdaptor.html) class. It is designed for scenarios where data operations such as **create**, **read**, **update**, and **delete** must be implemented manually or integrated with custom logic.
13+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor DataGrid supports custom data operations through the [CustomAdaptor](https://blazor.syncfusion.com/documentation/data/custom-binding) in the [SfDataManager](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.SfDataManager.html). This adaptor allows complete control over data handling by overriding methods in the [DataAdaptor](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DataAdaptor.html) class. It is designed for scenarios where data operations such as **read**, **insert**, **update**, and **delete** must be implemented manually or integrated with custom logic.
1414

1515
The `CustomAdaptor` is ideal for applications that require:
1616

@@ -498,8 +498,6 @@ The [DataManagerRequest](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor
498498
499499
* [PerformAggregation](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.DataUtil.html#Syncfusion_Blazor_Data_DataUtil_PerformAggregation_System_Collections_IEnumerable_System_Collections_Generic_List_Syncfusion_Blazor_Data_Aggregate__) - Applies **aggregate** details from `DataManagerRequest` to the data source using the `DataUtil` class to calculate summary values such as **Sum**, **Average**, **Min**, and **Max**.
500500
501-
These methods enable efficient client-side data handling in a custom adaptor implementation.
502-
503501
N> To enable these operations, install the **Syncfusion.Blazor.Data** package using NuGet Package Manager in Visual Studio:
504502

505503
(*ToolsNuGet Package ManagerManage NuGet Packages for Solution*).
@@ -1123,7 +1121,7 @@ CRUD operations for custom-bound data in the Syncfusion<sup style="font-size:70%
11231121

11241122
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor DataGrid allows sending custom parameters with each data request. This is useful for scenarios where additional information such as user role, authentication token, or custom filters must be passed to the server for processing.
11251123

1126-
Custom parameters can be added using the [Query](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_Query) property of the [SfGrid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html) along with the [AddParams](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.Query.html#Syncfusion_Blazor_Data_Query_AddParams_System_String_System_Object_) method of the `Query` class.
1124+
Custom parameters can be added using the [Query](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_Query) property of the [Grid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html) along with the [AddParams](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Data.Query.html#Syncfusion_Blazor_Data_Query_AddParams_System_String_System_Object_) method of the `Query` class.
11271125
11281126
To enable custom parameters in data requests for the Grid, follow these steps:
11291127

blazor/datagrid/connecting-to-adaptors/graphql-adaptor.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -557,11 +557,11 @@ The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor DataGrid supports se
557557
558558
**Key Operations**
559559
560-
* **Searching**: Uses **Search** property to filter records based on keywords and fields.
561-
* **Filtering**: Uses **Where** property to apply conditional filters on columns.
562-
* **Sorting**: Uses **Sorted** property to define sort fields and directions.
563-
* **Paging**: Uses **Skip** and **Take** properties to retrieve paged data.
564-
* **CRUD**: Uses GraphQL mutations for **Insert**, **Update**, **Delete**, and **Batch** operations.
560+
* **Searching**: Uses the **Search** property to filter records based on keywords and fields.
561+
* **Filtering**: Uses the **Where** property to apply conditional filters on columns.
562+
* **Sorting**: Uses the **Sorted** property to define sort fields and sort directions.
563+
* **Paging**: Uses the **Skip** and **Take** properties to retrieve paged data.
564+
* **CRUD**: Uses GraphQL mutations to perform **Insert, Update, Delete**, and **Batch** operations.
565565
566566
Each operation is handled on the server by parsing these parameters and applying the logic to the data source before returning the result to the DataGrid.
567567
@@ -998,7 +998,7 @@ public class OrdersDataResponse
998998
**Sorting** parameters are sent through the **Sorted** property of `DataManagerRequestInput`. Each sorting instruction includes:
999999
10001000
* **Name**: The column name to sort.
1001-
* **Direction**: The sort order (ascending or descending).
1001+
* **Direction**: The sort order (**ascending** or **descending**).
10021002
10031003
When a sort action is triggered in the DataGrid, these parameters are passed to the GraphQL server. The server applies the sorting logic and returns the sorted collection along with the total record count.
10041004
@@ -1275,7 +1275,7 @@ Mutation = new GraphQLMutation
12751275
},
12761276
```
12771277
1278-
**Parameters Sent to the Server**
1278+
**Parameters sent to the Server**
12791279
12801280
These parameters are passed to the mutation method for the `Insert` operation on the server:
12811281
@@ -1338,7 +1338,7 @@ Mutation = new GraphQLMutation
13381338
},
13391339
```
13401340
1341-
**Parameters Sent to the Server**
1341+
**Parameters sent to the Server**
13421342
13431343
These parameters are passed to the mutation method for the `Update` operation on the server:
13441344
@@ -1400,7 +1400,7 @@ Mutation = new GraphQLMutation
14001400
},
14011401
```
14021402
1403-
**Parameters Sent to the Server**
1403+
**Parameters sent to the Server**
14041404
14051405
These parameters are passed to the mutation method for the **Delete** operation on the server:
14061406
@@ -1602,7 +1602,7 @@ Mutation = new GraphQLMutation
16021602
16031603
```
16041604
1605-
**Parameters Sent to the Server**
1605+
**Parameters sent to the Server**
16061606
16071607
These parameters are passed to the mutation method for the **Batch** operation on the server:
16081608

blazor/datagrid/connecting-to-adaptors/odatav4-adaptor.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ When the application runs, the DataGrid displays data retrieved from the OData V
285285
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor DataGrid supports server-side operations such as **searching**, **sorting**, **filtering**, **paging**, and **CRUD** when connected to an **OData V4** service through the `ODataV4Adaptor`. These operations are executed on the server using **OData** query options:
286286

287287
* **$filter** – Applies **filter** conditions and **search** criteria from [DataManagerRequest](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.DataManagerRequest.html) to the data source.
288-
* **$orderby** – Applies **sort** descriptors from `DataManagerRequest` for ascending or descending order.
288+
* **$orderby** – Applies **sort** descriptors from `DataManagerRequest` for **ascending** or **descending** order.
289289
* **$skip, $top** – Applies **paging** details from `DataManagerRequest` to skip and retrieve records.
290290
* **$count** – Requests the total record count for **paging** and **aggregation**.
291291

@@ -356,7 +356,7 @@ builder.Services.AddControllers().AddOData(
356356

357357
## Handling filtering operation
358358

359-
Enable filtering by adding the **Filter** method in the OData configuration and setting [AllowFiltering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_AllowFiltering) property to **true** in [SfGrid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html). The **$filter** query option retrieves records based on specified criteria.
359+
Enable filtering by adding the **Filter** method in the OData configuration and setting [AllowFiltering](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_AllowFiltering) property to **true** in [Grid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html). The **$filter** query option retrieves records based on specified criteria.
360360

361361
{% tabs %}
362362
{% highlight cs tabtitle="program.cs" %}
@@ -409,7 +409,7 @@ builder.Services.AddControllers().AddOData(
409409

410410
## Handling sorting operation
411411

412-
Enable sorting by adding the **OrderBy** method in the OData configuration and setting [AllowSorting](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_AllowSorting) property to **true** in [SfGrid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html). The **$orderby** query option sorts records based on specified fields.
412+
Enable sorting by adding the **OrderBy** method in the OData configuration and setting [AllowSorting](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_AllowSorting) property to **true** in [Grid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html). The **$orderby** query option sorts records based on specified fields.
413413

414414
{% tabs %}
415415
{% highlight cs tabtitle="program.cs" %}
@@ -463,7 +463,7 @@ builder.Services.AddControllers().AddOData(
463463

464464
## Handling paging operation
465465

466-
Paging can be enabled using the **SetMaxTop** method in the OData configuration and setting [AllowPaging](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_AllowPaging) property to **true** in [SfGrid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html). The **$skip** and **$top** query options implement paging by skipping a specified number of records and retrieving the required count.
466+
Paging can be enabled using the **SetMaxTop** method in the OData configuration and setting [AllowPaging](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_AllowPaging) property to **true** in [Grid](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html). The **$skip** and **$top** query options implement paging by skipping a specified number of records and retrieving the required count.
467467

468468
{% tabs %}
469469
{% highlight cs tabtitle="program.cs" %}

0 commit comments

Comments
 (0)