Getting Started with ASP.NET Core CheckBox Control

22 Apr 20224 minutes to read

This section briefly explains about how to include ASP.NET Core CheckBox control in your ASP.NET Core application using Visual Studio.

Prerequisites

System requirements for ASP.NET Core controls

Create ASP.NET Core web application with Razor pages

Install ASP.NET Core package in the application

Syncfusion ASP.NET Core controls are available in nuget.org. Refer to NuGet packages topic to learn more about installing NuGet packages in various OS environments. To add ASP.NET Core controls in the application, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for Syncfusion.EJ2.AspNet.Core and then install it.

The Syncfusion.EJ2.AspNet.Core NuGet package has dependencies, Newtonsoft.Json for JSON serialization and Syncfusion.Licensing for validating Syncfusion license key.

Add Syncfusion ASP.NET Core Tag Helper

Open ~/Views/_ViewImports.cshtml file and import the Syncfusion.EJ2 TagHelper.

~/_ViewImports.cshtml
@addTagHelper *, Syncfusion.EJ2

Add style sheet

Checkout the Themes topic to learn different ways (CDN, NPM package, and CRG) to refer styles in ASP.NET Core application, and to have the expected appearance for Syncfusion ASP.NET Core controls. Here, the theme is referred using CDN inside the <head> of ~/Pages/Shared/_Layout.cshtml file as follows,

~/_Layout.cshtml
<head>
    ...
    <!-- Syncfusion ASP.NET Core controls styles -->
    <link rel="stylesheet" href="https://cdn.syncfusion.com/ej2/20.1.55/fluent.css" />
</head>

Add script reference

In this getting started walk-through, the required scripts are referred using CDN inside the <head> of ~/Pages/Shared/_Layout.cshtml file as follows,

~/_Layout.cshtml
<head>
    ...
    <!-- Syncfusion ASP.NET Core controls scripts -->
    <script src="https://cdn.syncfusion.com/ej2/20.1.55/dist/ej2.min.js"></script>
</head>

Register Syncfusion Script Manager

Open ~/Pages/Shared/_Layout.cshtml page and register the script manager at the end of `<body>` in the ASP.NET Core application as follows.

~/_Layout.cshtml
<body>
...
    <!-- Syncfusion ASP.NET Core Script Manager -->
    <ejs-scripts></ejs-scripts>
</body>

Add ASP.NET Core CheckBox control

Now, add the Syncfusion ASP.NET Core CheckBox tag helper in ~/Pages/Index.cshtml page.

CSHTML
<ejs-checkbox id="default" label="Default"  checked="true"></ejs-checkbox>

Press Ctrl+F5 (Windows) or ⌘+F5 (macOS) to run the app. Then, the Syncfusion ASP.NET Core CheckBox control will be rendered in the default web browser.

ASP.NET Core CheckBox Control

Change the CheckBox state

The Essential JS 2 CheckBox contains 3 different states visually, they are:

Checked
Unchecked
Indeterminate

The CheckBox checked property is used to handle the checked and unchecked state. In checked state, a tick mark will be added to the visualization of CheckBox.

Indeterminate

The CheckBox indeterminate state can be set through indeterminate property. CheckBox indeterminate state masks the real value of CheckBox visually. The Checkbox cannot be changed to indeterminate state through the user interface, this state can be achieved only through the property.

CSHTML
<ul>
    <li>
        <ejs-checkbox id="checked" checked="true" label="Checked State"></ejs-checkbox>
    </li>
    <li>
        <ejs-checkbox id="unchecked" label="Unchecked State"></ejs-checkbox>
    </li>
    <li>
        <ejs-checkbox id="indeterminate" indeterminate="true" label="Intermediate State"></ejs-checkbox>
    </li>
</ul>

<style>
    .e-checkbox-wrapper {
        margin-top: 18px;
    }

    li {
        list-style: none;
    }
</style>

View Sample in GitHub.