Frozen rows and columns in ASP.NET Core Grid Component

16 Feb 20247 minutes to read

Frozen rows and columns provides an option to make rows and columns always visible in the top and left side of the grid while scrolling.

In this demo, the FrozenColumns is set as 2 and the FrozenRows is set as 3. Hence, the left two columns and top three rows are frozen.

CSHTML
Freeze-row-column.cs
@Html.EJS().Grid("FrozenGrid").DataSource((IEnumerable<object>)ViewBag.datasource).AllowSelection(false).AllowResizing().Height("410").FrozenRows(2).FrozenColumns(1).Columns(col =>
{
   col.Field("OrderID").HeaderText("Order ID").Width("120").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("Freight").HeaderText("Freight").Width("120").Format("C2").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("OrderDate").HeaderText("Order Date").Width("130").Format("yMd").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("CustomerID").HeaderText("Customer Name").Width("200").Add();
   col.Field("ShipName").HeaderText("Ship Name").Width("150").Add();
   col.Field("ShippedDate").HeaderText("Shipped Date").Width("130").Format("yMd").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("ShipCity").HeaderText("Ship City").Width("200").Add();
   col.Field("ShipAddress").HeaderText("Ship Address").Width("150").Add();
   col.Field("ShipCountry").HeaderText("Ship Country").Width("150").Add();

}).Render()
public IActionResult Index()
 {
    ViewBag.datasource = OrdersDetails.GetAllRecords();            
    return View();
 }

NOTE

Frozen rows and columns should not be set outside the grid view port.

Frozen Grid will support row and column virtualization feature, which helps to improve the Grid performance while loading a large dataset.

Limitations of Frozen Grid

The following features are not supported in frozen rows and columns:

Detail Template
Hierarchy Grid
AutoFill

Freeze particular columns

To freeze particular column in the grid, the IsFrozen property can be used.

In this demo, the columns with field name OrderID and CustomerID is frozen using the IsFrozen property.

CSHTML
Freeze-column.cs
@Html.EJS().Grid("FrozenGrid").DataSource((IEnumerable<object>)ViewBag.datasource).AllowSelection(false).AllowResizing().Height("410").Columns(col =>
{
   col.Field("OrderID").HeaderText("Order ID").Width("120").IsFrozen(true).TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("Freight").HeaderText("Freight").Width("120").Format("C2").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("OrderDate").HeaderText("Order Date").Width("130").Format("yMd").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("CustomerID").HeaderText("Customer Name").IsFrozen(true).Width("200").Add();
   col.Field("ShipName").HeaderText("Ship Name").Width("150").Add();
   col.Field("ShippedDate").HeaderText("Shipped Date").Width("130").Format("yMd").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
   col.Field("ShipCity").HeaderText("Ship City").Width("200").Add();
   col.Field("ShipAddress").HeaderText("Ship Address").Width("150").Add();
   col.Field("ShipCountry").HeaderText("Ship Country").Width("150").Add();

}).Render()
public IActionResult Index()
 {
    var orders = OrderDetails.GetAllRecords();
    ViewBag.datasource = orders;            
    return View();
  }

Freeze Direction

You can freeze the Grid columns on the left or right side by using the column.freeze property and the remaining columns will be movable. The grid will automatically move the columns to the left or right position based on the column.freeze value.

Types of the column.freeze directions:

Left: Allows you to freeze the columns at the left.
Right: Allows you to freeze the columns at the right.
Fixed: Allows you to lock the column at a fixed position by ensuring its visibility during horizontal scroll.

In this demo, the ShipCountry column is frozen at the left and the CustomerID column is frozen at the right side of the content table.

CSHTML
Freeze-column.cs
@Html.EJS().Grid("FrozenGrid").DataSource((IEnumerable<object>)ViewBag.datasource).FrozenRows(2).Height("410").Columns(col =>
{
    col.Field("OrderID").HeaderText("Order ID").Width("120").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
    col.Field("Freight").HeaderText("Freight").Width("120").Format("C2").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
    col.Field("CustomerID").HeaderText("Customer ID").Width("150").Freeze(Syncfusion.EJ2.Grids.FreezeDirection.Right).Add();
    col.Field("EmployeeID").HeaderText("Employee ID").Width("120").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
    col.Field("OrderDate").HeaderText("Order Date").Width("130").Format("yMd").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add();
    col.Field("ShipName").HeaderText("Ship Name").Width("150").Add();
    col.Field("ShipAddress").HeaderText("Ship Address").Width("150").Add();
    col.Field("ShipCity").HeaderText("Ship City").Width("150").Add();
    col.Field("ShipCountry").HeaderText("Ship Country").Width("150").Freeze(Syncfusion.EJ2.Grids.FreezeDirection.Left).Add();
}).Render()
public IActionResult Index()
 {
    var orders = OrderDetails.GetAllRecords();
    ViewBag.datasource = orders;            
    return View();
  }

NOTE

Freeze Direction is not compatible with the isFrozen and frozenColumns properties.

Deprecated Methods

Deprecated Methods	Previous	Current	Suggested Alternative Methods	Example for achieving the same results
`getMovableRows()`	In the previous architecture of frozen grid, three separate tables were created for the left, right, and movable contents. When calling this method, it would return only the movable table rows (tr’s).	In the current architecture, the frozen left, right, and movable sections are applied within a single table. When calling this method, it will return all table rows (tr’s) of the entire table. However, in this approach, we have introduced the `e-unfreeze` class for movable cells. This allows us to selectively retrieve the movable rows using the `e-unfreeze` class selector.	`getRows()`	gridInstance.getMovableRows()[0].querySelectorAll(‘.e-unfreeze’) // Deprecated (or) gridInstance.getRows()[0].querySelectorAll(‘.e-unfreeze’) // Alternative method
`getFrozenRightRows()`	In the previous architecture, this method would return only the table rows (tr’s) from the freeze right table.	In the current architecture, the frozen left, right, and movable sections are applied within a single table. When calling this method, it will return all the rows (tr’s) of the entire table. In this new approach, we have introduced the `e-rightfreeze` class for right freeze cells. As a result, you can now selectively retrieve the right freeze rows using the `e-rightfreeze` class selector.	`getRows()`	gridInstance.getFrozenRightRows()[0].querySelectorAll(‘.e-rightfreeze’) // Deprecated (or) gridInstance.getRows()[0].querySelectorAll(‘.e-rightfreeze’) // Alternative method
`getMovableRowByIndex()` `getFrozenRowByIndex()` `getFrozenRightRowByIndex()`	In the previous architecture, you could select rows by using separate methods for each table section. Like, * `getMovableRowByIndex` - select a movable row * `getFrozenRowByIndex` - select a freeze row * `getFrozenRightRowByIndex` - select a right freeze row.	In the current architecture, the `getMovableRowByIndex`, `getFrozenRightRowByIndex` and `getFrozenRowByIndex` methods all return the same table row (tr) based on the given index. Additionally, class names for table cells (td’s) have been separated as follows: * Left-Freeze : `e-leftfreeze` * Movable : `e-unfreeze` * Right-Freeze : `e-rightfreeze`. This separation of class names makes it easier to target and customize the cells within the particular row.	`getRowByIndex()`	To get the left freeze cells: gridInstance.getRowByIndex(1).querySelectorAll(‘.e-leftfreeze’) To get the movable cells: gridInstance.getRowByIndex(1).querySelectorAll(‘.e-unfreeze’) To get the right freeze cells: gridInstance.getRowByIndex(1).querySelectorAll(‘.e-rightfreeze’)
`getMovableCellFromIndex()` `getFrozenRightCellFromIndex()`	* `getMovableCellFromIndex()` - select a particular cell in the movable table. * `getFrozenRightCellFromIndex()` - select a particular cell in the right freeze table.	In the new approach, you can select a particular cell by using both the `getFrozenRightCellFromIndex` and `getMovableCellFromIndex` methods.	`getCellFromIndex()`	gridInstance.getCellFromIndex(1,1)
`getMovableDataRows()` `getFrozenRightDataRows()` `getFrozenDataRows()`	These methods returns the viewport data rows for the freeze, movable, and right tables separately.	In the new approach, when calling the `getMovableDataRows`, `getFrozenRightDataRows`, and `getFrozenDataRows` methods, returns the entire viewport data rows. You can then select specific cells within these rows using the following selectors * Left-Freeze : `e-leftfreeze` * Movable : `e-unfreeze` * Right-Freeze : `e-rightfreeze`.	`getDataRows()`	To get the movable data cells: gridInstance.getDataRows()[0].querySelectorAll(‘.e-unfreeze’) To get the right freeze data cells: gridInstance.getDataRows()[0].querySelectorAll(‘.e-rightfreeze’) To get the left freeze data cells: gridInstance.getDataRows()[0].querySelectorAll(‘.e-leftfreeze’)
`getMovableColumnHeaderByIndex()` `getFrozenRightColumnHeaderByIndex()` `getFrozenLeftColumnHeaderByIndex()`	In the previous architecture, these methods selects the movable, right freeze, and left freeze headers from the table separately.	In the new approach, when calling the `getMovableColumnHeaderByIndex`, `getFrozenRightColumnHeaderByIndex`, and `getFrozenLeftColumnHeaderByIndex` methods, you will still receive the same results as before.	`getColumnHeaderByIndex`()	gridInstance.getColumnHeaderByIndex(1)

When a validation message is displayed in the frozen part (Left, Right, Fixed) of the table, scrolling is prevented until the validation message is cleared.