Using a Telerik UI for ASP.NET Core Project Template in VS for Windows

This tutorial shows how to create an ASP.NET Core web app that uses Telerik UI for ASP.NET Core components.

You will create a project from a template and configure it for Telerik UI by using the Visual Studio extensions. This method allows you to download the components and then create a pre-configured application that has all necessary scripts, styles, and editor templates so that you can immediately start adding the Telerik UI components.

If you need to add Telerik UI controls to an existing project, see the First Steps with VS for Windows tutorial.

You'll learn how to:

• Download and install the Telerik UI extensions.
• Create an ASP.NET Core MVC (Model-View-Controller) project.
• Initialize a DatePicker and a Grid.
• Bind data to Telerik UI widgets.
• Use the Telerik UI Themes.
• Add your license file.

Prerequisites

• .NET Core SDK

• Visual Studio 2017 or later

  For .NET Core 3.1 version or later, Visual Studio 2019 is required.

• Windows 10 or higher

• Telerik account—if you don't have an account yet, you can create one for free.

Installing the Telerik UI Extensions

1. Close any running Visual Studio instances.

2. Go to the Progress Telerik UI for ASP.NET Core Extension page and click Download.

   • For Visual Studio 2017 and 2019
   • For Visual Studio 2022

3. Locate and double-click the TelerikUI.ASP.NET.Core.VSPackage.vsix file to install the extensions.

Once you install the Telerik UI Extensions, you can open Visual Studio and start using the automated Create New Telerik Project wizard.

Creating the Project

1. In Visual Studio, select Create a new project.

2. Filter by project type and select Telerik from the drop-down.

   

3. Select Telerik ASP.NET Core MVC Application, and then select Next.

4. Name the project TelerikAspNetCoreApp and select Create.

   Using this name guarantees that the namespace from the code snippets in this tutorial will match your project.

   

5. From the drop-down boxes, select the .NET CORE framework and ASP.NET Core version 5.0.

   Telerik UI supports all ASP.NET Core versions, including 3.x, 5.0, and newer. The default is .NET 5.0.

6. Select HTML or Tag Helpers.

   Telerik UI for ASP.NET Core is a set of server-side wrappers (HTML and Tag Helpers) that allow you to use the Kendo UI widgets in .NET Core. When you select the helper type in the Create New Project Wizard, the wizard will configure the project for the selected helpers.

   In Razor files, Tag Helpers come with predefined strongly-typed attributes that enable server-side code to participate in the creation and rendering of HTML elements. The resulting markup is cleaner and easier to read than with traditional HTML Helpers, which are invoked as methods that are mixed with HTML inside your Razor views.

   

7. From the VERSION drop-down, select the latest Telerik UI version.

   • If you use the Telerik UI extensions for the first time, you will see a login window. Enter the credentials for your Telerik account to download the controls.
   • If you haven't purchased a license, download the trial version of the Telerik UI controls.

8. Select STANDARD, and then select Next.

   The wizard offers various templates for projects with pre-configured Grid and Menu controls and for projects using Razor Pages. This tutorial uses the STANDARD MVC version.

9. Select the default Boostrap-v4 theme, and then select Finish.

   The selected theme defines the appearance of the Telerik UI components. You can change the theme at any time.

Congratulations! The created project:

• Is a working app.

• Has all resources required by Telerik UI, and you can start adding components immediately.

Initializing a DatePicker

Next, you will add the first Telerik UI component to the project—the Telerik UI DatePicker. The Telerik UI extensions have already configured the project with all required Telerik UI resources, and all you need now is to add the DatePicker HTML or Tag Helper. Whether you select the HTML or Tag Helper syntax depends on what you have configured when you have created the project.

Utilize the Telerik UI DatePicker component by adding the snippet from the following example to ~/Views/Home/Index.cshtml.

    <div class="text-center">
        <h2>Telerik UI DatePicker for ASP.NET Core</h2>
        @(Html.Kendo().DatePicker()
            .Name("my-picker")
        )
    </div>

    <div class="text-center">
        <h2>Telerik UI DatePicker for ASP.NET Core</h2>
        <kendo-datepicker name="my-picker"/>
    </div>

Run the project. The following page is visualized in the browser:

Initializing a Grid and Binding Data

The next step is to add the more complex Telerik UI Grid to your project. You will bind the Grid to data, and this requires adding a model and controller.

1. Add a Models folder to the project. Create an OrderViewModel class and add it to the Models folder.

   The model represents the shape of the data that the Grid will display.

       public class OrderViewModel
       {
           public int OrderID
           {
               get;
               set;
           }
   
           public decimal? Freight
           {
               get;
               set;
           }
   
           public DateTime? OrderDate
           {
               get;
               set;
           }
   
           public string ShipCity
           {
               get;
               set;
           }
   
           public string ShipName
           {
               get;
               set;
           }
       }
   

   When the Grid is bound to a strongly-typed model such as the OrderViewModel, it automatically detects the data types of the fields.

2. Right-click the Controllers folder. Select Add > Controller..., and then select Add.

   The controller handles the incoming requests, retrieves the model data, and then returns the requested data.

3. Name the file GridController.

4. In GridController.cs, add the following declarations at the top. They enable the data processing by the Telerik UI extensions:

       using Kendo.Mvc.Extensions;
       using Kendo.Mvc.UI;
       using Microsoft.AspNetCore.Mvc;
       using System;
       using System.Linq;
       using TelerikAspNetCoreApp.Models;
   

5. In GridController.cs, add an ActionMethod that will return the data for the Grid.

       public class GridController : Controller
       {
           public ActionResult Orders_Read([DataSourceRequest] DataSourceRequest request)
           {
               var result = Enumerable.Range(0, 50).Select(i => new OrderViewModel
               {
                   OrderID = i,
                   Freight = i * 10,
                   OrderDate = new DateTime(2016, 9, 15).AddDays(i % 7),
                   ShipName = "ShipName " + i,
                   ShipCity = "ShipCity " + i
               });
   
               var dsResult = result.ToDataSourceResult(request);
               return Json(dsResult);
           }
       }
   

6. In the ~/Views/Home/Index.cshtml file, add the Grid:

       @(Html.Kendo().Grid <TelerikAspNetCoreApp.Models.OrderViewModel>()
           .Name("grid")
           .Columns(columns =>
           {
               columns.Bound(p => p.OrderID).Filterable(false);
               columns.Bound(p => p.Freight);
               columns.Bound(p => p.OrderDate).Format("{0:MM/dd/yyyy}");
               columns.Bound(p => p.ShipName);
               columns.Bound(p => p.ShipCity);
           })
           .Pageable()
           .Sortable()
           .Scrollable()
           .Filterable()
           .HtmlAttributes(new { style = "height:550px;" })
           .DataSource(dataSource => dataSource
               .Ajax()
               .PageSize(20)
               .Read(read => read.Action("Orders_Read", "Grid"))
               )
       )
   

       <kendo-grid name="grid" height="550">
           <columns>
               <column field="OrderID" title="Order ID">
                   <filterable enabled="false"></filterable>
               </column>
               <column field="Freight" title="Freight" />
               <column field="OrderDate" title="Order Date" format="{0:MM/dd/yyyy}" />
               <column field="ShipName" title="Ship Name" />
               <column field="ShipCity" title="Ship City" />
           </columns>
           <scrollable enabled="true" />
           <sortable enabled="true" />
           <pageable enabled="true" />
           <filterable enabled="true" />
           <datasource type="DataSourceTagHelperType.Ajax" page-size="20">
               <transport>
                   <read url="@Url.Action("Orders_Read", "Grid")" />
               </transport>
           </datasource>
       </kendo-grid>
   

7. Run the project.

For more information on data processing and data binding, see the following articles:

• Binding the Grid to a database
• CRUD operations

Next, you can change the look and feel of your application by selecting another visual theme.

Changing the App Theme

The UI for ASP.NET Core suite comes with a set of 20+ built-in LESS-based and Sass-based themes that allow you to alter the visual appearance of the Telerik components. The most prominent themes are Default (our own styling), Material (based on the Material Design guidelines), and Bootstrap (a theme that matches Bootstrap guidelines).

The themes are usually referenced in the _Layout file of the application. To change the theme, substitute the existing CSS reference in the _Layout with the new theme.

If during the creation the project you've chosen the Bootstrap theme, the _Layout.cshtml file must contain the following CSS link:

    <link href="https://kendo.cdn.telerik.com/themes/10.0.1/bootstrap/bootstrap-main.css" rel="stylesheet" type="text/css" />

To change the theme to the Default theme, substitute the link above with the following:

    <link href="https://kendo.cdn.telerik.com/themes/10.0.1/default/default-main.css" rel="stylesheet" type="text/css" />

Since both the Bootstrap and Default themes are Sass-based themes, no additional CSS files are required. LESS theme files are no longer support after the R1 2023 SP1 release. If you need to reference LESS CSS files in an older version of the Telerik UI for ASP.NET Core, you must add a common and a theme CSS files. The following example shows how to reference the Default LESS theme (applicable to versions of Telerik UI for ASP.NET Core before R1 2023 SP1):

    <link rel="stylesheet" href="https://kendo.cdn.telerik.com/2022.3.1109/styles/kendo.common.min.css" />
    <link rel="stylesheet" href="https://kendo.cdn.telerik.com/2022.3.1109/styles/kendo.default.min.css" />

The default casing for JSON strings in ASP.NET Core is camelCase. The Telerik UI components that are data-bound depend on PascalCase formatted response from the server. If the JSON serialization isn't configured properly, the UI components will display wrong data. To find out how to configure the application to return the data in Pascal-case, refer to the JSON Serialization article.

Adding Your License File

Using any client-side assets from the Kendo UI CDN or the @progress/kendo-ui NPM package requires you to add a Kendo UI for jQuery license file to your application. A missing license file triggers a banner, a watermark, and causes a warning message in the browser's console.

To generate your license file and add it to your application, follow the instructions in the Adding a License File article.

Next Steps

• Check out the free Telerik UI onboarding course
• Getting Started with Telerik UI Video Tutorial
• Using Telerik UI in Razor Pages projects
• Create your own custom bundles
• Switch from Trial to Commercial License

See Also

• Installing UI for ASP.NET Core with NuGet
• Installing UI for ASP.NET Core by Using the CDN Services