Row selection in ASP.NET Core Grid component
10 Dec 202424 minutes to read
Row selection in the Grid component allows you to interactively select specific rows or ranges of rows within the grid. This selection can be done effortlessly through mouse clicks or arrow keys (up, down, left, and right). This feature is useful when you want to highlight, manipulate, or perform actions on specific row within the Grid.
To enable row selection, you should set the selectionSettings.mode property to either Row or Both. This property determines the selection mode of the grid.
Single row selection
Single row selection allows you to select a single row at a time within the Grid. This feature is useful when you want to focus on specific rows or perform actions on the data within a particular row.
To enable single row selection, set the selectionSettings.mode property to Row and the selectionSettings.type property to Single. This configuration allows you to select a only one row at a time within the grid.
Here’s an example of how to enable single row selection using properties:
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px">
<e-grid-selectionsettings mode= "Row" type="Single"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Multiple row selection
Multiple row selection allows you to select multiple rows within the Grid. This feature is valuable when you need to perform actions on several rows simultaneously or focus on specific data areas.
To enable multiple row selection, set the selectionSettings.mode property to Row and the selectionSettings.type property to Multiple. This configuration allows you to select a multiple rows at a time within the grid.
Here’s an example of how to enable multiple rows selection using properties:
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px">
<e-grid-selectionsettings mode= "Row" type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Select row at initial rendering
You have the ability to select a specific row during the initial rendering of the Grid component. This feature is particularly useful when you want to highlight or pre-select a specific row in the grid. To achieve this, you can utilize the selectedRowIndex property provided by the Grid component.
In the following example, it demonstrates how to select a row at initial rendering:
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" selectedRowIndex=1 height="348px">
<e-grid-selectionsettings mode= "Row" type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Select rows in any page based on index value
The Grid allows you to select rows in any page based on their index value. This feature is useful when you want to perform specific actions on rows, such as highlighting, applying styles, or executing operations, regardless of their location across multiple pages within the grid.
To achieve this, you can utilize the selectRow method and the goToPage method of the Grid control. By handling the change event of DropDownList component, you can implement the logic to navigate to the desired page and select the row based on the index value.
Additionally, by handling the actionComplete event of the Grid, you can maintain the selection of the desired row after completing the paging action.
The following example demonstrates how to select rows in any page based on index value using actionComplete and change event:
@{
var dropDownData = new[] {
new { text = "Select row index", value = "" },
new { text = "1", value = "1" },
new { text = "2", value = "2" },
new { text = "15", value = "15" },
new { text = "80", value = "80" },
new { text = "110", value = "110" },
new { text = "120", value = "120" },
new { text = "210", value = "210" },
new { text = "310", value = "310" },
new { text = "410", value = "410" },
new { text = "230", value = "230" }
};
}
<div style="padding-bottom:20px">
<div style="display: flex;">
<label style="padding: 5px 5px 0 0;font-weight: bold"> Select Row :</label>
<span style="height:fit-content">
<ejs-dropdownlist id="dropDown" width="150px" index="0" dataSource=dropDownData change="valueChange">
</ejs-dropdownlist>
</span>
</div>
</div>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" actionComplete="actionComplete" allowPaging="true" height="348px">
<e-grid-pageSettings pageSize="10" ></e-grid-pageSettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
let value;
let modulus;
function actionComplete(args) {
var grid = document.getElementById("grid").ej2_instances[0];
if (args.requestType === "paging") {
grid.selectRow(modulus);
}
}
function valueChange(args) {
var grid = document.getElementById("grid").ej2_instances[0];
value = +args.value;
modulus = (value - 1) % 10;
var page = Math.ceil(value / 10);
if (page === 1) {
if (grid.pagerModule.pagerObj.currentPage != 1) {
grid.pagerModule.goToPage(1);
}
grid.selectRow(modulus);
}
else {
grid.pagerModule.goToPage(page);
if (grid.pagerModule.pagerObj.currentPage == page) {
grid.selectRow(modulus);
}
}
}
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Multiple row selection by single click on row
The Grid component allows you to perform multiple row selection by simply clicking on rows one by one without pressing CTRL or SHIFT keys. This means that when you click on a row, it will be selected, and clicking on another row will add it to the selection without deselecting the previously selected rows. To deselect a previously selected row, you can click on the row again, and it will be unselected.
To enable the simple multiple row selection, you need to set the selectionSettings.enableSimpleMultiRowSelection property to true.
The following example demonstrates how to enable multiple row selection with a single click on the Grid row using enableSimpleMultiRowSelection property:
<div style="padding-bottom: 20px; display: flex">
<label style="margin-right:5px;margin-top: -3px;font-weight: bold;">Enable/Disable simple multiple row selection </label>
<ejs-switch id="switch" change="toggleRowSelection"></ejs-switch>
</div>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px">
<e-grid-selectionsettings type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
function toggleRowSelection(args) {
var grid = document.getElementById("grid").ej2_instances[0];
grid.selectionSettings.enableSimpleMultiRowSelection =args.checked;
}
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Select rows externally
You can perform single row selection, multiple row selection, and range of row selection externally in a Grid using built-in methods. This feature allows you to interact with specific rows within the Grid. The following topic demonstrates how you can achieve these selections using methods.
Single row selection
Single row selection allows you to select a single row at a time within the Grid. This feature is useful when you want to focus on specific rows or perform actions on the data within a particular row.
To achieve single row selection, you can use the selectRow method. This method allows you to programmatically select a specific row within the Grid by specifying its index.
The following example demonstrates how to select a single row within the Grid by obtaining the selected row index through a TextBox component and passing these row index as argument to the selectRow method. When the button event is triggered by clicking the Select Row button, a single row is selected within the Grid:
<div style="padding-bottom: 20px">
<label style="padding: 30px 5px 0 0;font-weight: bold">Enter the row index:</label>
<ejs-textbox id="inputTextBox" width="120px"></ejs-textbox>
<ejs-button id="buttons" cssClass="e-primary custom" content="Select Row"></ejs-button>
</div>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px">
<e-grid-selectionsettings mode= "Row" type="Single"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
document.getElementById('buttons').onclick = function () {
var grid = document.getElementById("grid").ej2_instances[0];
var textBox = document.getElementById("inputTextBox").ej2_instances[0];
rowIndex = parseInt(textBox.element.value, 10);
if (!isNaN(rowIndex)) {
grid.selectRow(rowIndex);
}
};
</script>
<style>
.custom{
margin-left: 10px;
}
</style>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Multiple rows selection
The ASP.NET Core Grid allows you to select multiple rows within the grid simultaneously. This feature is valuable when you need to perform actions or operations on several rows at once or focus on specific areas of your data.
To achieve multiple row selection, you can use the selectRows method. This method allows you to select a collection of rows by specifying their indexes, giving you the ability to interact with multiple rows together.
The following example, demonstrates how to select multiple rows in the Grid by calling the selectRows method within the button onclick event and passing an array of row indexes as arguments.
<div style="padding: 10px 0px 20px 0px">
<ejs-button id="buttonOne" cssClass="e-primary" content="select [1, 3]"></ejs-button>
<ejs-button id="buttonTwo" cssClass="e-primary custom" content="select [0, 2]"></ejs-button>
<ejs-button id="buttonThree" cssClass="e-primary custom" content="select [2, 4]"></ejs-button>
<ejs-button id="buttonFour" cssClass="e-primary custom" content="select [0,5]"></ejs-button>
<ejs-button id="buttonFive" cssClass="e-primary custom" content="select [1,6]"></ejs-button>
</div>
<div style="padding: 10px 0px 20px 0px">
<ejs-button id="buttonSix" cssClass="e-primary" content="select [0,7,8]"></ejs-button>
<ejs-button id="buttonSeven" cssClass="e-primary custom" content="select [1,9,10]"></ejs-button>
<ejs-button id="buttonEight" cssClass="e-primary custom" content="select [4,7,12]"></ejs-button>
<ejs-button id="buttonNine" cssClass="e-primary custom" content="select [2,5,6]"></ejs-button>
</div>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px">
<e-grid-selectionsettings mode= "Row" type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
document.getElementById('buttonOne').onclick = handleButtonClick;
document.getElementById('buttonTwo').onclick = handleButtonClick;
document.getElementById('buttonThree').onclick = handleButtonClick;
document.getElementById('buttonFour').onclick = handleButtonClick;
document.getElementById('buttonFive').onclick = handleButtonClick;
document.getElementById('buttonSix').onclick = handleButtonClick;
document.getElementById('buttonSeven').onclick = handleButtonClick;
document.getElementById('buttonEight').onclick = handleButtonClick;
document.getElementById('buttonNine').onclick = handleButtonClick;
function handleButtonClick(event){
var grid = document.getElementById("grid").ej2_instances[0];
grid.clearRowSelection();
if(event.target.id === "buttonOne") grid.selectRows([1, 3]);
else if (event.target.id === "buttonTwo") grid.selectRows([0, 2]);
else if (event.target.id === "buttonThree") grid.selectRows([2, 4]);
else if (event.target.id === "buttonFour") grid.selectRows([0, 5]);
else if (event.target.id === "buttonFive") grid.selectRows([1, 6]);
else if (event.target.id === "buttonSix") grid.selectRows([0, 7, 8]);
else if (event.target.id === "buttonSeven") grid.selectRows([1, 9, 10]);
else if (event.target.id === "buttonEight") grid.selectRows([4, 7, 12]);
else if (event.target.id === "buttonNine") grid.selectRows([2, 5, 6]);
}
</script>
<style>
.custom{
margin-left: 5px;
}
</style>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Range of rows selection
Range of row selection in the Grid enables you to select a continuous range of rows within the grid. This feature is particularly useful when you want to perform actions on multiple rows simultaneously or focus on a specific range of data.
To achieve range of row selection, you can use the selectRowsByRange method. This method selects a range of rows from start and end row indexes.
The following example, demonstrates how to select a range of rows within the Grid by obtaining the selected rows start index and end index through TextBox components. Then, pass these start index and end index as arguments to the selectRowsByRange method. When you trigger the button event by clicking the Select Rows button, a range of rows is selected within the Grid.
<div style="padding-bottom: 20px">
<div>
<label style="padding: 30px 5px 0 0;font-weight: bold">Enter the start row index:</label>
<ejs-textbox id="inputTextBox" width="120px"></ejs-textbox>
</div>
<div>
<label style="padding: 30px 5px 0 0;font-weight: bold">Enter the end row index:</label>
<ejs-textbox id="inputTextBoxLast" width="120px"></ejs-textbox>
</div>
<div style="padding-top: 20px;margin-left: 185px;">
<ejs-button id="buttons" cssClass="e-primary" content="Select Row"></ejs-button>
</div>
</div>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px">
<e-grid-selectionsettings mode= "Row" type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
document.getElementById('buttons').onclick = function () {
var grid = document.getElementById("grid").ej2_instances[0];
var textBoxStart = document.getElementById("inputTextBox").ej2_instances[0];
var textBoxEnd = document.getElementById("inputTextBoxLast").ej2_instances[0];
let startIndex = parseInt(textBoxStart.value, 10);
let endIndex = parseInt(textBoxEnd.value, 10);
grid.selectionModule.clearRowSelection();
if (!isNaN(startIndex) && !isNaN(endIndex)) {
grid.selectionModule.selectRowsByRange(startIndex, endIndex);
}
};
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Select grid rows based on certain condition
You can programmatically select specific rows in the ASP.NET Core Grid component based on a certain condition. This feature is particularly useful when you need to dynamically highlight or manipulate specific rows in the grid based on custom conditions. This functionality can be achieved using the selectRows method in the dataBound event of Grid and rowDataBound along with obtaining the index value based on the condition.
In the below demo, we have selected the grid rows only when EmployeeID column value greater than 3.
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px" dataBound="dataBound" allowPaging="true" rowDataBound="rowDataBound">
<e-grid-selectionsettings mode= "Row" type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="EmployeeID" headerText="Employee ID" width="150"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
let cellIndex =[];
function rowDataBound(args) {
if (args.data['EmployeeID'] > 3) {
cellIndex.push(parseInt(args.row.getAttribute('data-rowindex'), 10));
}
}
function dataBound() {
var grid = document.getElementById("grid").ej2_instances[0];
if (cellIndex.length) {
grid.selectRows(cellIndex);
cellIndex = [];
}
}
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
How to get selected row indexes
You can retrieve the indexes of the currently selected rows in the Grid component. This feature is particularly useful when you need to perform actions or operations specifically on the selected rows.
To achieve this, you can leverage the getSelectedRowIndexes method, which returns an array of numbers representing the indexes of the selected rows.
The following example demonstrates how to get selected row indexes using getSelectedRowIndexes method:
<div style="padding-bottom: 20px">
<ejs-button id="buttons" cssClass="e-primary" content="Get selected row indexes"></ejs-button>
</div>
<p style="color:red;text-align:center" id="message"></p>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px">
<e-grid-selectionsettings type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
document.getElementById('buttons').onclick = function () {
var grid = document.getElementById("grid").ej2_instances[0];
let selectedRowIndexes = grid.getSelectedRowIndexes();
if (selectedRowIndexes.length > 0) {
document.getElementById("message").innerText = `Selected row indexes: ${selectedRowIndexes}`;
}
else {
document.getElementById("message").innerText = '';
}
}
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
How to get selected records on various pages
The Grid component allows you to retrieve the selected records even when navigating to different pages. This feature is useful when working with large data sets and allows you to perform actions on the selected records across multiple pages.
To persist the selection across pages, you need to enable the persistselection property. By default, this property is set to false. To enable it, set the value to true in the selectionSettings property of the Grid component.
To retrieve the selected records from different pages, you can use the getSelectedRecords method. This method returns an array of the selected records.
The following example demonstrates how to retrieve selected records from various pages using the getSelectedRecords method and display OrderID in a dialog when a button is clicked:
<div style="padding-bottom: 20px">
<ejs-button id="buttons" cssClass="e-primary" content="Show Selected Records"></ejs-button>
</div>
<div id="dialog" ></div>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px" allowPaging="true">
<e-grid-selectionsettings mode="Row" type="Multiple" persistSelection="true"></e-grid-selectionsettings>
<e-grid-pagesettings pageCount="10"></e-grid-pagesettings>
<e-grid-columns>
<e-grid-column type="checkbox" width="50"></e-grid-column>
<e-grid-column field="OrderID" headerText="Order ID" width="120" isPrimaryKey="true" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
let dialogVisible = true;
let dialog = new ej.popups.Dialog({
header: 'Selected Records',
showCloseIcon: true,
position: { X: 560, Y: 280 },
width: '400px',
visible: false,
close: dialogClose,
});
dialog.appendTo('#dialog');
function dialogClose() {
dialogVisible = false;
}
document.getElementById('buttons').onclick = function () {
var grid = document.getElementById("grid").ej2_instances[0];
let selectedRecords = grid.getSelectedRecords();
if (selectedRecords.length>0) {
dialog.visible = true;
dialog.content = '';
for (let i = 0; i < selectedRecords.length; i++) {
dialog.content += `<p><b>OrderID:</b> ${(selectedRecords[i]).OrderID}</p>`;
}
}
};
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
To persist the grid selection, it is necessary to define any one of the columns as a primary key using the columns property.
How to get selected records
The get selected records allows you to retrieve the data of the selected rows from the Grid component. This can be particularly useful when you need to perform actions on the selected data or display specific information based on the selected rows.
To retrieve the selected records, you can use the getSelectedRecords method. This method allows you to obtain an array of objects representing the selected records.
Here’s an example that displays the selected row count using the getSelectedRecords method:
<div style="padding-bottom: 10px">
<ejs-button id="buttons" cssClass="e-primary" content="Selected Records Count"></ejs-button>
</div>
<p style="color:red;text-align:center" id="message"></p>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px" allowSelection="true" allowPaging="true">
<e-grid-selectionsettings mode="Row" type="Multiple"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
let selectedRecordscount = 0;
document.getElementById('buttons').onclick = function () {
var grid = document.getElementById("grid").ej2_instances[0];
selectedRecordscount = grid.getSelectedRecords().length;
if (selectedRecordscount > 0) {
document.getElementById("message").innerText = `Selected record count: ${selectedRecordscount}`;
}
else {
document.getElementById("message").innerText = '';
}
}
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Clear row selection programmatically
Clearing row selection programmatically in the Grid component is a useful feature when you want to remove any existing row selections. To achieve this, you can use the clearRowSelection method.
The
clearRowSelectionmethod is applicable when the selection type is set to Multiple or Single.
The following example demonstrates how to clear row selection by calling the clearRowSelection method in the button onclick event.
<div style="padding-bottom: 10px">
<ejs-button id="buttons" cssClass="e-primary" content="Clear Row Selection"></ejs-button>
</div>
<p style="color:red;text-align:center" id="message"></p>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px" allowPaging="true" allowSelection="true" selectedRowIndex="2">
<e-grid-selectionsettings type="Multiple" mode="Row"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
document.getElementById('buttons').onclick = function () {
var grid = document.getElementById("grid").ej2_instances[0];
grid.selectionModule.clearRowSelection();
};
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}
Row selection events
The Grid provides several events related to row selection that allow you to respond to and customize the behavior of row selection. These events give you control over various aspects of row selection. Here are the available row selection events:
rowSelecting: This event is triggered before any row selection occurs. It provides an opportunity to implement custom logic or validation before a row is selected, allowing you to control the selection process.
rowSelected: This event is triggered after a row is successfully selected. You can use this event to perform actions or updates when a row is selected.
rowDeselecting: This event is triggered just before a selected row is deselected. It allows you to perform custom logic or validation to decide whether the row should be deselected or not.
rowDeselected: This event is triggered when a particular selected row is deselected. You can use this event to perform actions or validations when a row is no longer selected.
In the following example, row selection is canceled when the value of CustomerID is equal to VINET within the rowSelecting event. The background color changes to green when the value of Freight is greater than 10 and less than or equal to 140, triggering the rowDeselected event. The background color changes to red when the value of Freight is less than or equal to 10 during the rowDeselected event. Furthermore, the background color changes to yellow when the value of Freight is greater than 140 during the rowDeselected event. A notification message is displayed to indicate which event was triggered whenever a row is selected.
<p style="color:red;text-align:center" id="message"></p>
<ejs-grid id="grid" dataSource="@ViewBag.dataSource" height="348px" allowPaging="true" enableHover="true" rowSelected="rowSelected" allowSelection="true" rowSelecting="rowSelecting" rowDeselected="rowDeselected" rowDeselecting="rowDeselecting">
<e-grid-selectionsettings type="Multiple" mode="Row"></e-grid-selectionsettings>
<e-grid-columns>
<e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Right"></e-grid-column>
<e-grid-column field="CustomerID" headerText="Customer Name" width="150"></e-grid-column>
<e-grid-column field="OrderDate" headerText="Order Date" width="130" format="yMd" textAlign="Right"></e-grid-column>
<e-grid-column field="Freight" headerText="Freight" width="120" format="C2" textAlign="Right"></e-grid-column>
<e-grid-column field="ShipCountry" headerText="Ship Country" width="150"></e-grid-column>
</e-grid-columns>
</ejs-grid>
<script>
function rowSelecting(args)
{
if (args.data.CustomerID == 'VINET')
{
document.getElementById("message").innerText = `Trigger rowSelecting`;
args.cancel = true;
}
else
document.getElementById("message").innerText='';
}
function rowSelected(args)
{
if (args.data.Freight > '10' || args.data.Freight <= '140')
{
document.getElementById("message").innerText = ` Trigger rowSelected`;
args.row.style.backgroundColor = 'rgb(96, 158, 101)';
}
}
function rowDeselected(args)
{
if (args.data.Freight <= '10')
{
document.getElementById("message").innerText = `Trigger rowDeselected`;
args.row.style.backgroundColor = 'red';
}
}
function rowDeselecting(args)
{
if (args.data.Freight > '140')
{
document.getElementById("message").innerText = `Trigger rowDeselecting`;
args.row.style.backgroundColor = 'yellow';
}
}
</script>public IActionResult Index()
{
ViewBag.dataSource = OrderDetails.GetAllRecords();
return View();
}