Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linmasaki/kendonet.dynamiclinq
Elevate Your Kendo UI Experience with this ASP.NET Core's Free Package!
https://github.com/linmasaki/kendonet.dynamiclinq
dynamic jquery kendo kendo-ui linq net netcore netstandard
Last synced: about 2 months ago
JSON representation
Elevate Your Kendo UI Experience with this ASP.NET Core's Free Package!
- Host: GitHub
- URL: https://github.com/linmasaki/kendonet.dynamiclinq
- Owner: linmasaki
- License: mit
- Created: 2016-12-29T03:50:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T23:11:20.000Z (over 1 year ago)
- Last Synced: 2024-12-19T13:07:04.276Z (about 2 months ago)
- Topics: dynamic, jquery, kendo, kendo-ui, linq, net, netcore, netstandard
- Language: C#
- Homepage:
- Size: 118 KB
- Stars: 46
- Watchers: 5
- Forks: 23
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# KendoNET.DynamicLinq
[](https://www.nuget.org/packages/KendoNET.DynamicLinq)
[](https://www.nuget.org/packages/KendoNET.DynamicLinq)
[](#)
## Description
KendoNET.DynamicLinq implements server paging, filtering, sorting, grouping, and aggregating to Kendo UI via Dynamic Linq for .Net Core App(1.x ~ 3.x).
## Prerequisites
### .Net Core 1 ~ 2
- None
### .Net Core 3
- You must add custom `ObjectToInferredTypesConverter` to your `JsonSerializerOptions` since `System.Text.Json` didn't deserialize inferred type to object properties now, see
the [sample code](https://github.com/linmasaki/KendoNET.DynamicLinq/blob/master/test/KendoNET.DynamicLinq.Tests/CustomJsonSerializerOptions.cs)
and [reference](https://docs.microsoft.com/en-gb/dotnet/standard/serialization/system-text-json-converters-how-to#deserialize-inferred-types-to-object-properties).
## Usage
1. Add the KendoNET.DynamicLinq NuGet package to your project.
2. Configure your Kendo DataSource to send its options as JSON.
```javascript
parameterMap: function(options, type) {
return JSON.stringify(options);
}
```
3. Configure the `schema` of the dataSource.
```javascript
schema: {
data: "Data",
total: "Total",
aggregates: "Aggregates",
groups: "Groups",
errors: "Errors"
}
```
4. The completed code like below.
```javascript
..... Other kendo grid code .....
dataSource: {
schema:
{
data: "Data",
total: "Total",
aggregates: "Aggregates",
groups: "Groups",
errors: "Errors",
...
},
transport: {
read: {
url: 'your read url',
dataType: 'json',
contentType: 'application/json; charset=utf-8',
type: 'POST'
},
create: {
url: 'your create url',
dataType: "json",
contentType: 'application/json; charset=utf-8',
type: 'POST'
},
parameterMap: function (data, operation) {
return JSON.stringify(data);
}
},
error: function(e) {
console.log(e.errors); // Your error information
e.sender.cancelChanges();
},
pageSize: 20,
serverPaging: true,
serverFiltering: true,
serverSorting: true,
...
}
..... Other kendo grid code .....
```
5. Import the KendoNET.DynamicLinq namespace.
6. Use the `ToDataSourceResult` extension method to apply paging, sorting, filtering, grouping and aggregating.
```c#
using KendoNET.DynamicLinq
[WebMethod]
public static DataSourceResult Products(int take, int skip, IEnumerable sort, Filter filter, IEnumerable aggregates, IEnumerable groups)
{
using (var northwind = new Northwind())
{
return northwind.Products
.OrderBy(p => p.ProductID) // EF requires ordering for paging
.Select(p => new ProductViewModel // Use a view model to avoid serializing internal Entity Framework properties as JSON
{
ProductID = p.ProductID,
ProductName = p.ProductName,
UnitPrice = p.UnitPrice,
UnitsInStock = p.UnitsInStock,
Discontinued = p.Discontinued
})
.ToDataSourceResult(take, skip, sort, filter, aggregates, groups);
}
}
```
or from Kendo UI request
```c#
using KendoNET.DynamicLinq
[HttpPost]
public IActionResult Products([FromBody] DataSourceRequest requestModel)
{
using (var northwind = new Northwind())
{
return northwind.Products
.Select(p => new ProductViewModel // Use a view model to avoid serializing internal Entity Framework properties as JSON
{
ProductID = p.ProductID,
ProductName = p.ProductName,
UnitPrice = p.UnitPrice,
UnitsInStock = p.UnitsInStock,
Discontinued = p.Discontinued
})
.ToDataSourceResult(requestModel.Take, requestModel.Skip, requestModel.Sort, requestModel.Filter, requestModel.Aggregate, requestModel.Group);
}
}
```
## Known Issues
When server-side filterable options are enabled and apply a query with filter condition that contains `DateTime` type column, then EntityFramework Core would throw an
exception `System.Data.SqlClient.SqlException (0x80131904): Conversion failed when converting date and/or time from character string`. The error is caused by a known issue in some old EntityFramework
Core versions. The workaround is adding `datetime` value to the related column in DbContext. e.g.
```c#
public class MyContext : DbContext
{
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
..........
modelBuilder.Entity().Property(x => x.UpdateTime).HasColumnType("datetime");
..........
}
}
```
## How To Build NuGet Package
1. Open command line console
2. Switch to project root directory(src\KendoNET.DynamicLinq).
3. Run "dotnet restore"
4. Run "dotnet pack --configuration Release"
5. Add `` to package metadata of nupkg to show repository URL at Nuget
## Note
KendoNET.DynamicLinq is a reference to [Ali Sarkis's](https://github.com/mshtawythug/dlinq-helpers) Kendo.DynamicLinq.
## Kendo UI Documentation
The following links are Kendo UI online docs(related to this package) and you can refer to.
- [Kendo UI Grid](https://docs.telerik.com/kendo-ui/api/javascript/ui/grid)
- [Kendo DataSource](https://docs.telerik.com/kendo-ui/api/javascript/data/datasource)
More Kendo UI configuration can refer to [here](https://demos.telerik.com/kendo-ui/)