Grid in Razor Pages

Razor Pages is an alternative to the MVC pattern that makes page-focused coding easier and more productive. This approach consists of a cshtml file and a cshtml.cs file (by design, the two files have the same name).

You can seamlessly integrate the Telerik UI Grid for ASP.NET Core in Razor Pages applications.

This article describes how to configure the Grid component in a Razor Pages scenario.

For the complete project, refer to the Grid in Razor Pages example.

Getting Started

To configure the CRUD operations of the Grid DataSource within a Razor Pages application, follow the next steps:

Specify the Read, Create, Update, and Destroy options of the DataSource configuration. The URL in each of these options must refer to the method name in the PageModel.

    @page
    @model IndexModel
    @using Kendo.Mvc.UI

    @(Html.Kendo().Grid<OrderViewModel>()
        .Name("grid")
        .Editable()
        .Scrollable()
        .Pageable()
        .ToolBar(t => t.Create())
        .Columns(columns =>
        {
            columns.Bound(column => column.Freight);
            columns.Bound(column => column.ShipName);
            columns.Bound(column => column.ShipCity);
            columns.Command(column =>
            {
                column.Edit();
                column.Destroy();
            }).Width(230);
        })
        .DataSource(ds => ds
            .Ajax()
            .Read(r => r.Url("/Index?handler=Read").Data("forgeryToken"))
            .Update(u => u.Url("/Index?handler=Update").Data("forgeryToken"))
            .Create(c => c.Url("/Index?handler=Create").Data("forgeryToken"))
            .Destroy(d => d.Url("/Index?handler=Destroy").Data("forgeryToken"))
            .Model(m => m.Id(id => id.OrderID))
            .PageSize(10)
        )
    )

    @page
    @model IndexModel
    @using Kendo.Mvc.UI

    <kendo-grid name="grid">
        <datasource type="DataSourceTagHelperType.Ajax" page-size="10">
            <schema data="Data" errors="Errors" total="Total">
                <model id="OrderID">
                    <fields>
                        <field name="OrderID" type="number" editable="false"></field>
                        <field name="Freight" type="number"></field>
                        <field name="ShipName" type="string"></field>
                        <field name="ShipCity" type="string"></field>
                    </fields>
                </model>
            </schema>
            <transport>
                <read url="/Index?handler=Read" data="forgeryToken"/>
                <update url="/Index?handler=Update" data="forgeryToken"/>
                <create url="/Index?handler=Create" data="forgeryToken"/>
                <destroy url="/Index?handler=Destroy" data="forgeryToken"/>
            </transport>
        </datasource>
        <columns>
            <column field="Freight"/>
            <column field="ShipName"/>
            <column field="ShipCity"/>
            <column width="230">
                <commands>
                    <column-command text="Edit" name="edit"></column-command>
                    <column-command text="Delete" name="destroy"></column-command>
                </commands>
            </column>
        </columns>
        <toolbar>
            <toolbar-button name="create"></toolbar-button> 
        </toolbar>
        <editable mode="inline"/>
        <pageable enabled="true"/>
        <scrollable enabled="true"/>
    </kendo-grid>

Add an AntiForgeryToken at the top of the page.

    @inject Microsoft.AspNetCore.Antiforgery.IAntiforgery Xsrf
    @Html.AntiForgeryToken()

Send the AntiForgeryToken with the CRUD requests.

    <script>
        function forgeryToken() {
            return kendo.antiForgeryTokens();
        }
    </script>

Additional parameters can also be supplied.

    <script>
        function forgeryToken() {
            return {
                __RequestVerificationToken: kendo.antiForgeryTokens().__RequestVerificationToken,
                additionalParameter: "test"
            }
        }
    </script>

Within the cshtml.cs file, add a handler method for each data operation.

    public static IList<OrderViewModel> orders;

    public void OnGet()
    {
        if (orders == null)
        {
            // Populate the "orders" collection with data.
            orders = new List<OrderViewModel>();
            Enumerable.Range(1, 50).ToList().ForEach(i => orders.Add(new OrderViewModel
            {
                OrderID = i,
                Freight = i * 10,
                ShipName = "ShipName " + i,
                ShipCity = "ShipCity " + i
            }));
        }
    }

    public JsonResult OnPostRead([DataSourceRequest] DataSourceRequest request)
    {
        return new JsonResult(orders.ToDataSourceResult(request));
    }

    public JsonResult OnPostCreate([DataSourceRequest] DataSourceRequest request, OrderViewModel order)
    {
        order.OrderID = orders.Count + 1;
        orders.Add(order);

        return new JsonResult(new[] { order }.ToDataSourceResult(request, ModelState));
    }

    public JsonResult OnPostUpdate([DataSourceRequest] DataSourceRequest request, OrderViewModel order)
    {
        orders.Where(x => x.OrderID == order.OrderID).Select(x => order);

        return new JsonResult(new[] { order }.ToDataSourceResult(request, ModelState));
    }

    public JsonResult OnPostDestroy([DataSourceRequest] DataSourceRequest request, OrderViewModel order)
    {
        orders.Remove(orders.FirstOrDefault(x => x.OrderID == order.OrderID));

        return new JsonResult(new[] { order }.ToDataSourceResult(request, ModelState));
    }

    public class OrderViewModel
    {
        public int OrderID { get; set; }

        public decimal? Freight { get; set; }

        public string ShipCity { get; set; }

        public string ShipName { get; set; }
    }

Binding the Grid to a PageModel Property

To bind the Grid to a property from the PageModel, follow the next steps:

Add a property to the PageModel that holds the data collection that must be loaded in the Grid.

    public class GridPageModel : PageModel
    {
        [BindProperty]
        public IList<OrderViewModel> orders { get; set; }

        public void OnGet()
        {
            orders = new List<OrderViewModel>();
            // Populate the collection with data.
            Enumerable.Range(1, 50).ToList().ForEach(i => orders.Add(new OrderViewModel
            {
                OrderID = i + 1,
                Freight = i * 10,
                ShipName = "ShipName " + i,
                ShipCity = "ShipCity " + i
            }));
        }
    }

Declare the PageModel at the top of the page.
```
    @model GridPageModel
```

Bind the Grid to the collection property and disable the server data operations (ServerOperations(false)).

    @page
    @model IndexModel
    @using Kendo.Mvc.UI

    @inject Microsoft.AspNetCore.Antiforgery.IAntiforgery Xsrf
    @Html.AntiForgeryToken()

    @(Html.Kendo().Grid<OrderViewModel>(Model.orders)
        .Name("grid")
        .Scrollable()
        .Pageable()
        .Columns(columns =>
        {
            columns.Bound(column => column.Freight);
            columns.Bound(column => column.ShipName);
            columns.Bound(column => column.ShipCity);
        })
        .DataSource(ds => ds
            .Ajax()
            .PageSize(20)
            .ServerOperation(false)
        )
    )

Grid in Razor Pages

Getting Started

Binding the Grid to a PageModel Property

See Also

Getting Started

Support Resources

Community