Headers in ASP.NET Core Grid component

6 Dec 202424 minutes to read

The Syncfusion® ASP.NET Core Grid component provides a comprehensive set of options to customize and manage headers efficiently. Headers play a crucial role in organizing and presenting data effectively in the grid.

Header text

The headerText feature proves particularly beneficial when there is a need for more meaningful and descriptive column headers in the Syncfusion® ASP.NET Core Grid component.

By default, the header text of a column in Grid is displayed from the column’s field value. However, you can easily override the default header title and provide a custom header text for the column using the headerText property.

To enable the headerText property, you simply need to define it in the e-grid-column element. The following example demonstrates how to enable header text for a Grid column.

<ejs-grid id="Grid" dataSource="@ViewBag.DataSource">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="140" textAlign='Left'></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" textAlign="Right" format='C' width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="140"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
public IActionResult Index()
{
    var Order = OrdersDetails.GetAllRecords();
    ViewBag.DataSource = Order;
    return View();
}

Header text

  • If both the field and headerText are not defined in the column, the column renders with empty header text.
  • The headerText property is optional, and if it is not defined, then the corresponding column’s field value is set as header text for that column.
  • You can also use the headerTemplate property to apply custom HTML content to the header cell.

Header template

The header template feature in the Syncfusion® ASP.NET Core Grid component allows you to create custom header layouts and content, providing enhanced functionality such as sorting or filtering.

To implement a header template, set the headerTemplate property within a specific column definition. This allows you to render custom HTML elements or ASP.NET Core components to the header.

The following example demonstrate, the custom element is rendered for both CustomerID,Freight and OrderDate column headers.

<ejs-grid id="Grid" dataSource="@(ViewBag.DataSource)" headerCellInfo="onHeaderCellInfo">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerTemplate="#customerTemplate" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText='Freight' width="120" headerTemplate="#freightTemplate" textAlign="Right"></e-grid-column>
        <e-grid-column field="OrderDate" headerTemplate="#datetemplate" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<style>
    @@font-face {
        font-family: 'ej2-headertemplate';
        src: url(data:application/x-font-ttf;charset=utf-8;base64,AAEAAAAKAIAAAwAgT1MvMj1vTFIAAAEoAAAAVmNtYXDS2c5qAAABjAAAAEBnbHlmQmNFrQAAAdQAAANoaGVhZBRdbkIAAADQAAAANmhoZWEIUQQEAAAArAAAACRobXR4DAAAAAAAAYAAAAAMbG9jYQCOAbQAAAHMAAAACG1heHABHgENAAABCAAAACBuYW1lohGZJQAABTwAAAKpcG9zdA2o3w0AAAfoAAAAQAABAAAEAAAAAFwEAAAAAAAD9AABAAAAAAAAAAAAAAAAAAAAAwABAAAAAQAATBXy9l8PPPUACwQAAAAAANillKkAAAAA2KWUqQAAAAAD9APzAAAACAACAAAAAAAAAAEAAAADAQEAEQAAAAAAAgAAAAoACgAAAP8AAAAAAAAAAQQAAZAABQAAAokCzAAAAI8CiQLMAAAB6wAyAQgAAAIABQMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAUGZFZABA5wLpYAQAAAAAXAQAAAAAAAABAAAAAAAABAAAAAQAAAAEAAAAAAAAAgAAAAMAAAAUAAMAAQAAABQABAAsAAAABgAEAAEAAucC6WD//wAA5wLpYP//AAAAAAABAAYABgAAAAIAAQAAAAAAjgG0ABEAAAAAA8kD8wADAAcACwAPABMAFwAbAB8AIwAnACsALwAzADcAOwBPAGsAACUVIzUjFSM1IxUjNSMVIzUjFSM1JRUjNSMVIzUjFSM1IxUjNSMVIzUlFSM1IxUjNSMVIzUjFSM1IxUjNQMVHwYhPwcRITcjDwghNS8HIzUjFSE1IwN2U1NTU1RTU1NTAuxTU1NTVFNTU1MC7FNTU1NUU1NTU1QCAwUGBggIA0QICAcHBQQBAvxsp30ICAcHAgUDAQEDlAECBAUHBwgIfVP+YFOzU1NTU1NTU1NTU6dUVFRUVFRUVFRUplNTU1NTU1NTU1P+NgQIBwcGBAMCAQIEBQcHAwgCdPoBAgQFAwcHCIF8CQgHBgUEAgFTU1MABAAAAAAD9APeADQAbQCuAQAAAAEfCDc1Lwc1PwIPBy8HHww3HwQPATMVPwc1Lx0jDwMfAgUdAR8GBTUzLxQjDx0BFxUfEDsBPxA1Nyc1LxIPEhUCCg8OGxcVExANCgMBAQMDCQQDAgECAxESEhMTExUUFRQTFBISEhEHCwYHCAkKCw0NDw8SuQQGAwIBAgRxlgsKCQcGBAMBAgMDAwUFBQcGBwgICQkKCgsKDAsMDQwNDQ4NDg45BQUDAQEEA/1eAgUGBwkKCwHjeggKDhEUFxs1FRMSEA4NCwoJBwcJBjwODg0ODQ0MDQwLDAoLCgoJCQgIBwYHBQUFAwMDAgEBAQECAgYICg0ODxISFBUXFwwMDA0MDQwMFxcVFBISDw4MCwgGAgIBAQICAwcJCw0PERITFRUXDAwMDA0NDAwMDAsXFRQTEQ8ODQoIBgICAVQEAwgJCgsMCwwbEBAREREZEA8VDAwKCgoIBwYFAwIBAQIDBQYHCAoUFQwLCwsLCgoJCAcGMwsWFhUVHB3QAQIEBggICgueDg4ODg0NDA0MCwsLCwoKCQgJBwgGBwUFBAQDAwECCw8NDxETCrIlawsKCAgGBAIB0AoLCwoLCQgNCAkLDA0NDg4ODg4ZFAIBAwMEBAUGBgYIBwkICQoKCwsLDAwMDA0ODQ4ODgH7DQwMDBgWFRQTERAODAoIBgICAQECAgYICgwOEBETFBUWGAwMDA0MDQwMCxcWFRMSEA8NDAkHAwIBAQEBAQECAwMICwwOEBETFBUWFwwMDQAAAAASAN4AAQAAAAAAAAABAAAAAQAAAAAAAQASAAEAAQAAAAAAAgAHABMAAQAAAAAAAwASABoAAQAAAAAABAASACwAAQAAAAAABQALAD4AAQAAAAAABgASAEkAAQAAAAAACgAsAFsAAQAAAAAACwASAIcAAwABBAkAAAACAJkAAwABBAkAAQAkAJsAAwABBAkAAgAOAL8AAwABBAkAAwAkAM0AAwABBAkABAAkAPEAAwABBAkABQAWARUAAwABBAkABgAkASsAAwABBAkACgBYAU8AAwABBAkACwAkAacgZWoyLWhlYWRlcnRlbXBsYXRlUmVndWxhcmVqMi1oZWFkZXJ0ZW1wbGF0ZWVqMi1oZWFkZXJ0ZW1wbGF0ZVZlcnNpb24gMS4wZWoyLWhlYWRlcnRlbXBsYXRlRm9udCBnZW5lcmF0ZWQgdXNpbmcgU3luY2Z1c2lvbiBNZXRybyBTdHVkaW93d3cuc3luY2Z1c2lvbi5jb20AIABlAGoAMgAtAGgAZQBhAGQAZQByAHQAZQBtAHAAbABhAHQAZQBSAGUAZwB1AGwAYQByAGUAagAyAC0AaABlAGEAZABlAHIAdABlAG0AcABsAGEAdABlAGUAagAyAC0AaABlAGEAZABlAHIAdABlAG0AcABsAGEAdABlAFYAZQByAHMAaQBvAG4AIAAxAC4AMABlAGoAMgAtAGgAZQBhAGQAZQByAHQAZQBtAHAAbABhAHQAZQBGAG8AbgB0ACAAZwBlAG4AZQByAGEAdABlAGQAIAB1AHMAaQBuAGcAIABTAHkAbgBjAGYAdQBzAGkAbwBuACAATQBlAHQAcgBvACAAUwB0AHUAZABpAG8AdwB3AHcALgBzAHkAbgBjAGYAdQBzAGkAbwBuAC4AYwBvAG0AAAAAAgAAAAAAAAAKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADAQIBAwEEAAtCVF9DYWxlbmRhcghlbXBsb3llZQAA) format('truetype');
        font-weight: normal;
        font-style: normal;
    }
    .e-icon-calender::before {
        font-family: 'ej2-headertemplate';
        content: "\e960";
    }
    .e-icon-userlogin::before {
        font-family: 'ej2-headertemplate';
        content: "\e702";
    }
</style>
<script id="customerTemplate" type="text/x-template">
    <div>
        <span class="e-icon-userlogin e-icons employee">Customer ID</span>
    </div>
</script>
<script id="freightTemplate" type="text/x-template">
    <div id='dropdown'></div>
</script>
<script id="datetemplate" type="text/x-template">
    <div style="display:inline-flex">
        <div id="switch"></div>
        <label style="padding: 0px 0px 0px 10px" id="dateLabel">Order Date</label>
    </div>
</script>
<script>
    var headerText = "Order Date";
    var dropDownData = ["Freight", "Shipment", "Cargo"]
    function onHeaderCellInfo(args) {
        if (args.cell.column.field === 'Freight') {
            var dropDownElement = args.node.querySelector('#dropdown');
            if (dropDownElement) {
                new ej.dropdowns.DropDownList({
                    index:"0",
                    width:"130",
                    dataSource: dropDownData
                }).appendTo(dropDownElement);
            }
        }
        if (args.cell.column.field === 'OrderDate')
        {
            var switchElement = args.node.querySelector('#switch');
            if (switchElement) {
                new ej.buttons.Switch({
                    change: onSwitchToggle
                }).appendTo(switchElement);
            }
        }
    }
    function onSwitchToggle(args) {
        headerText = args.checked ? "Purchase Date" : "Order Date";
        document.getElementById('dateLabel').innerText = headerText;
    }
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Header template

  • The headerTemplate property is only applicable to Grid columns that have a header element.
  • You can use any HTML or ASP.NET Core component in the header template to add additional functionality to the header element.

Stacked header

In Grid, you can group multiple levels of column headers by stacking the Grid columns. This feature allows you to organize the Grid columns in a more structured and understandable way. This can be achieved by setting the columns->columns property. Within this property, you can define an array of column objects to group together as sub-headers under a main header. You can define the headerText property of each sub-header column to set the text for that sub-header.

You can customize the appearance of the stacked header elements by using the headerTemplate property. This allows you to render custom HTML elements or ASP.NET Core components to the header.

Here’s an example of how to use stacked headers with a custom headerTemplate in Syncfusion® Grid.

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">

<ejs-grid id="Grid" dataSource="@(ViewBag.DataSource)" headerCellInfo="onHeaderCellInfo">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' headerTemplate="#orderIDTemplate" width=120></e-grid-column>
        <e-grid-column headerText="Order Details"
            columns="@( new List<Syncfusion.EJ2.Grids.GridColumn>() { new Syncfusion.EJ2.Grids.GridColumn { Field = "OrderDate", Width = "130", HeaderText = "Order Date", Format="yMd",HeaderTemplate= "#datetemplate" ,TextAlign= Syncfusion.EJ2.Grids.TextAlign.Right,MinWidth="10" },
                new Syncfusion.EJ2.Grids.GridColumn { Field = "Freight", Width = "135", HeaderText = "Freight($)", Format="C2",  TextAlign= Syncfusion.EJ2.Grids.TextAlign.Right,  MinWidth="10" } } )"
                width="130" headerTemplate="#orderDetailsTemplate"></e-grid-column>
        <e-grid-column headerText="Shipped Details" headerTemplate="#shipDetailsTemplate" columns="@( new List<Syncfusion.EJ2.Grids.GridColumn>() { new Syncfusion.EJ2.Grids.GridColumn { Field = "ShippedDate", Width = "140", HeaderText = "Shipped Date", TextAlign=Syncfusion.EJ2.Grids.TextAlign.Right, Format="yMd",  MinWidth="10"  },
            new Syncfusion.EJ2.Grids.GridColumn { Field = "ShipCountry", Width = "145", HeaderText = "Ship Country", MinWidth="10" } } )">
        </e-grid-column>
    </e-grid-columns>
</ejs-grid>
<style>
    @@font-face {
        font-family: "ej2-headertemplate";
        src: url(data:application/x-font-ttf;charset=utf-8;base64,AAEAAAAKAIAAAwAgT1MvMj1vTFIAAAEoAAAAVmNtYXDS2c5qAAABjAAAAEBnbHlmQmNFrQAAAdQAAANoaGVhZBRdbkIAAADQAAAANmhoZWEIUQQEAAAArAAAACRobXR4DAAAAAAAAYAAAAAMbG9jYQCOAbQAAAHMAAAACG1heHABHgENAAABCAAAACBuYW1lohGZJQAABTwAAAKpcG9zdA2o3w0AAAfoAAAAQAABAAAEAAAAAFwEAAAAAAAD9AABAAAAAAAAAAAAAAAAAAAAAwABAAAAAQAATBXy9l8PPPUACwQAAAAAANillKkAAAAA2KWUqQAAAAAD9APzAAAACAACAAAAAAAAAAEAAAADAQEAEQAAAAAAAgAAAAoACgAAAP8AAAAAAAAAAQQAAZAABQAAAokCzAAAAI8CiQLMAAAB6wAyAQgAAAIABQMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAUGZFZABA5wLpYAQAAAAAXAQAAAAAAAABAAAAAAAABAAAAAQAAAAEAAAAAAAAAgAAAAMAAAAUAAMAAQAAABQABAAsAAAABgAEAAEAAucC6WD//wAA5wLpYP//AAAAAAABAAYABgAAAAIAAQAAAAAAjgG0ABEAAAAAA8kD8wADAAcACwAPABMAFwAbAB8AIwAnACsALwAzADcAOwBPAGsAACUVIzUjFSM1IxUjNSMVIzUjFSM1JRUjNSMVIzUjFSM1IxUjNSMVIzUlFSM1IxUjNSMVIzUjFSM1IxUjNQMVHwYhPwcRITcjDwghNS8HIzUjFSE1IwN2U1NTU1RTU1NTAuxTU1NTVFNTU1MC7FNTU1NUU1NTU1QCAwUGBggIA0QICAcHBQQBAvxsp30ICAcHAgUDAQEDlAECBAUHBwgIfVP+YFOzU1NTU1NTU1NTU6dUVFRUVFRUVFRUplNTU1NTU1NTU1P+NgQIBwcGBAMCAQIEBQcHAwgCdPoBAgQFAwcHCIF8CQgHBgUEAgFTU1MABAAAAAAD9APeADQAbQCuAQAAAAEfCDc1Lwc1PwIPBy8HHww3HwQPATMVPwc1Lx0jDwMfAgUdAR8GBTUzLxQjDx0BFxUfEDsBPxA1Nyc1LxIPEhUCCg8OGxcVExANCgMBAQMDCQQDAgECAxESEhMTExUUFRQTFBISEhEHCwYHCAkKCw0NDw8SuQQGAwIBAgRxlgsKCQcGBAMBAgMDAwUFBQcGBwgICQkKCgsKDAsMDQwNDQ4NDg45BQUDAQEEA/1eAgUGBwkKCwHjeggKDhEUFxs1FRMSEA4NCwoJBwcJBjwODg0ODQ0MDQwLDAoLCgoJCQgIBwYHBQUFAwMDAgEBAQECAgYICg0ODxISFBUXFwwMDA0MDQwMFxcVFBISDw4MCwgGAgIBAQICAwcJCw0PERITFRUXDAwMDA0NDAwMDAsXFRQTEQ8ODQoIBgICAVQEAwgJCgsMCwwbEBAREREZEA8VDAwKCgoIBwYFAwIBAQIDBQYHCAoUFQwLCwsLCgoJCAcGMwsWFhUVHB3QAQIEBggICgueDg4ODg0NDA0MCwsLCwoKCQgJBwgGBwUFBAQDAwECCw8NDxETCrIlawsKCAgGBAIB0AoLCwoLCQgNCAkLDA0NDg4ODg4ZFAIBAwMEBAUGBgYIBwkICQoKCwsLDAwMDA0ODQ4ODgH7DQwMDBgWFRQTERAODAoIBgICAQECAgYICgwOEBETFBUWGAwMDA0MDQwMCxcWFRMSEA8NDAkHAwIBAQEBAQECAwMICwwOEBETFBUWFwwMDQAAAAASAN4AAQAAAAAAAAABAAAAAQAAAAAAAQASAAEAAQAAAAAAAgAHABMAAQAAAAAAAwASABoAAQAAAAAABAASACwAAQAAAAAABQALAD4AAQAAAAAABgASAEkAAQAAAAAACgAsAFsAAQAAAAAACwASAIcAAwABBAkAAAACAJkAAwABBAkAAQAkAJsAAwABBAkAAgAOAL8AAwABBAkAAwAkAM0AAwABBAkABAAkAPEAAwABBAkABQAWARUAAwABBAkABgAkASsAAwABBAkACgBYAU8AAwABBAkACwAkAacgZWoyLWhlYWRlcnRlbXBsYXRlUmVndWxhcmVqMi1oZWFkZXJ0ZW1wbGF0ZWVqMi1oZWFkZXJ0ZW1wbGF0ZVZlcnNpb24gMS4wZWoyLWhlYWRlcnRlbXBsYXRlRm9udCBnZW5lcmF0ZWQgdXNpbmcgU3luY2Z1c2lvbiBNZXRybyBTdHVkaW93d3cuc3luY2Z1c2lvbi5jb20AIABlAGoAMgAtAGgAZQBhAGQAZQByAHQAZQBtAHAAbABhAHQAZQBSAGUAZwB1AGwAYQByAGUAagAyAC0AaABlAGEAZABlAHIAdABlAG0AcABsAGEAdABlAGUAagAyAC0AaABlAGEAZABlAHIAdABlAG0AcABsAGEAdABlAFYAZQByAHMAaQBvAG4AIAAxAC4AMABlAGoAMgAtAGgAZQBhAGQAZQByAHQAZQBtAHAAbABhAHQAZQBGAG8AbgB0ACAAZwBlAG4AZQByAGEAdABlAGQAIAB1AHMAaQBuAGcAIABTAHkAbgBjAGYAdQBzAGkAbwBuACAATQBlAHQAcgBvACAAUwB0AHUAZABpAG8AdwB3AHcALgBzAHkAbgBjAGYAdQBzAGkAbwBuAC4AYwBvAG0AAAAAAgAAAAAAAAAKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADAQIBAwEEAAtCVF9DYWxlbmRhcghlbXBsb3llZQAA) format("truetype");
        font-weight: normal;
        font-style: normal;
    }
    .e-icon-calender::before {
        font-family: "ej2-headertemplate";
        content: "\e960";
    }

</style>
<script id="orderIDTemplate" type="text/x-template">
    <a href="#">OrderID</a>
</script>
<script id="shipDetailsTemplate" type="text/x-template">
    <div> <span>Ship Details</span>
    <span>(<i class="fa fa-truck"></i>)
    </span></div>
</script>
<script id="orderDetailsTemplate" type="text/x-template">
    <div id='dropdown'></div>
</script>
<script id="datetemplate" type="text/x-template">
    <div>
        <span style="padding-right: 7px;" class="e-icon-calender e-icons headericon"></span>
        Order Date
    <div>    
</script>
<script>
    var dropDownData = ["Order Details", "Order Information"]
    function onHeaderCellInfo(args) {
        if (args.cell.column.headerText === 'Order Details') {
            var dropDownElement = args.node.querySelector('#dropdown');
            if (dropDownElement) {
                new ej.dropdowns.DropDownList({
                    index:"0",
                    dataSource: dropDownData
                }).appendTo(dropDownElement);
            }
        }
    }
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource= orders;
  return View();
}

Stacked header

Align the text of header text

You can horizontally align the text in column headers of the Grid component using the headerTextAlign property. By default, the text is aligned to the left, but you can change the alignment by setting the value of the headerTextAlign property to one of the following options:

  • Left: Aligns the text to the left (default).
  • Center: Aligns the text to the center.
  • Right: Aligns the text to the right.
  • Justify: Header text is justified.

The following example demonstrates how to dynamically change the alignment of the header text based on DropDown change:

@{
    ViewBag.dropDownData = new List<object>
    {
        new { value = "Left", text = "Left" },
        new { value = "Right", text = "Right" },
        new { value = "Center", text = "Center" },
        new { value = "Justify", text = "Justify" }
    };
}
<div style="display: flex">
    <label style="padding: 3px 10px 26px 0; font-weight: bold"> Align the text of header text : </label>
    <span style="height:fit-content">
        <ejs-dropdownlist id="dropDown" index="0" dataSource="@ViewBag.dropdownData" change="changeAlignment"></ejs-dropdownlist>
    </span>
</div>
<ejs-grid id="Grid" dataSource="@ViewBag.DataSource" height="315px">
    <e-grid-columns>
        <e-grid-column field="OrderID" headerText="Order ID" width="120" textAlign="Left"></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID"  width="140"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" format="C" width="120" textAlign="Left"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" format="yMd" width="140" textAlign="Left"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<script type="text/javascript">
    function changeAlignment(args) {
        var grid = document.getElementById("Grid").ej2_instances[0];
        grid.columnModel.forEach((column) => {
            column.headerTextAlign = args.value;
        });
        grid.refreshHeader();
    }
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  ViewBag.dropdownData = new string[] { "Left", "Right", "Center", "Justify"};
  return View();
}

Align the text of header text

  • The headerTextAlign property only changes the alignment of the text in the column header, and not the content of the column. If you want to align both the column header and content, you can use the textAlign property.
  • You can also use the headerTextAlign property with the stacked header feature in Syncfusion® Grid. The property will align the header text in the sub-headers as well.

Autowrap the header text

The autowrap allows the cell content of the grid to wrap to the next line when it exceeds the boundary of the specified cell width. The cell content wrapping works based on the position of white space between words. To support the Autowrap functionality in Syncfusion® Grid, you should set the appropriate width for the columns. The column width defines the maximum width of a column and helps to wrap the content automatically.

To enable autowrap, set the allowTextWrap property to true. You can also configure the auto wrap mode by setting the textWrapSettings.wrapMode property.

Grid provides the below three options for configuring:

  • Both: This is the default value for wrapMode. With this option, both the grid header text and content is wrapped.
  • Header: With this option, only the grid header text is wrapped.
  • Content: With this option, only the grid content is wrapped.
  • If a column width is not specified, then the Autowrap of columns will be adjusted with respect to the grid’s width.
  • If a column’s header text contains no white space, the text may not be wrapped.
  • If the content of a cell contains HTML tags, the Autowrap functionality may not work as expected. In such cases, you can use the headerTemplate and template properties of the column to customize the appearance of the header and cell content.

The following example demonstrates how to dynamically change the auto-wrap of the header text based on DropDown change.

@{
    ViewBag.dropDownData = new List<object>
    {
        new { value = "Header", text = "Header" },
        new { value = "Both", text = "Both" }
    };
}
<div style="display: flex">
    <label style="padding: 3px 10px 26px 0"> Change the wrapmode of auto wrap feature: </label>
    <span style="height:fit-content">
        <ejs-dropdownlist id="dropdown" index="0" dataSource="@ViewBag.dropDownData" change="valueChange"></ejs-dropdownlist>
    </span>
</div>
<ejs-grid id="Grid" dataSource="@ViewBag.DataSource" allowTextWrap=true>
    <e-grid-textwrapsettings wrapMode="Header"></e-grid-textwrapsettings>
    <e-grid-columns>
        <e-grid-column field="Inventor" headerText="Inventor Name" textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="NumberOfPatentFamilies" headerText="Number of Patent families" textAlign="Right" width="150"></e-grid-column>
        <e-grid-column field="Country" headerText="Country" width="100"></e-grid-column>
        <e-grid-column field="Active" headerText="Active" textAlign="Right" width="100"></e-grid-column>
        <e-grid-column field="Mainfieldsofinvention" headerText="Main Fields Of Invention" width="150"></e-grid-column>
    </e-grid-columns>
</ejs-grid>

<script type="text/javascript">
    function valueChange(args) {
        var grid = document.getElementById("Grid").ej2_instances[0];
        grid.textWrapSettings.wrapMode = args.value;
    }
</script>
public IActionResult Index()
{
    var Order = InventoryDetails.GetAllRecords();
    ViewBag.DataSource = Order;
    ViewBag.dropdownData = new string[] { "Header", "Both" };
    return View();
}

Autowrap the header text

Change the height of header

Changing the height of the header can be useful in cases where the default height is not sufficient to display the header content cell. For example, if you have a header with a lot of text or if you want to add an image to the header, you may need to increase the height of the header to accommodate the content.This can be easily achieved by changing the height of the header using CSS or by dynamically adjusting the height using a methods.

Using css

You can use CSS to override the default height of the .e-grid .e-headercell class to change the height of the header. Here is an example code snippet:

.e-grid .e-headercell {
  height: 130px;
}

Using methods

To change the height of the header dynamically, you can use the getHeaderContent method to get the header content element of the Syncfusion® Grid. Then, you can use the querySelectorAll method to get all the header cell elements with the class e-headercell. Finally, you can loop through each header cell element and set its style property to adjust the height.

The following example demonstrates how to dynamically change the height of the header based on a Button click event.

<div id="changeHeight">
    <ejs-button id="small" content="Change height 20px"></ejs-button>
    <ejs-button id="medium" content="Default height 42px"></ejs-button>
    <ejs-button id="big" content="Change height 60px"></ejs-button>
</div>
<div style='padding:20px 0px 0px 0px'>
<ejs-grid id="Grid" dataSource="@ViewBag.DataSource">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight"  format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
</div>
<style>
#medium,
#big {
  margin-left: 20px;
}
</style>
<script>
    document.getElementById('changeHeight').addEventListener('click', function (event) {
        var grid = document.getElementById("Grid").ej2_instances[0];
        const heightMap = {
              small: "20px",
              medium: "34px",
              big: "60px",
        };
        const headerCells = grid.getHeaderContent().querySelectorAll(".e-headercell");
        headerCells.forEach((headerCell) => {
          headerCell.style.height = heightMap[event.target.id];
        });
    });
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Change the height of header

  • You can also use the getHeaderTable method to get the table element of the header, and then adjust the height.
  • You cannot change the height of row below the default height of 42px using the e-columnheader class.

Change header text dynamically

The Syncfusion® Grid component provides a way to modify the header text of a corresponding column in real-time based on events or other events. This feature can be useful in various scenarios, such as displaying a custom header text for a specific column or updating the header text dynamically based on input. By allowing for dynamic changes to the header text, the Grid provides a more flexible and customizable experience.

Using Event

To modify the header text of a corresponding column dynamically, you can use the headerCellInfo event provided by the Syncfusion® Grid. This event is triggered for each header cell element rendered in the Grid.

When the HeaderCellInfo event is triggered, it provides a HeaderCellInfoEventArgs object as a parameter. This object contains the following properties:

  • cell: Defines the header cell that is being modified.
  • node: Defines the DOM element of the header cell that is being modified.

You can use these properties to access and modify the header text of the corresponding column. Once the header text is modified, you can refresh the Grid to reflect the changes by calling the refreshHeader method of the Grid.

Using method

The Grid component provides several methods that allow you to change the column header text dynamically. Here are some of the methods you can use:

  1. getColumnByField: This method takes a field name as a parameter and returns the entire column object that corresponds to that field name, including properties such as headerText, width, and alignment. You can use this method to modify any aspect of the column.

  2. getColumnHeaderByField: Retrieves the header element of a column based on its field name. You can modify the textContent property of the header element to change the header text. This method does not return a reference to the column object itself, only to the header element.

  3. getColumnIndexByField: Retrieves the index of a column based on its field name. You can then use the getColumnByIndex method to retrieve the column object and modify its headerText property to change the header text.

  4. getColumnByUid: Retrieves the column object based on its unique identifier (UID). You can modify the headerText property of the column object to change the header text.

  5. getColumnHeaderByIndex: Retrieves the header element of a column based on its zero-based index. You can modify the textContent property of the header element to change the header text. This method does not return a reference to the column object itself, only to the header element.

  6. getColumnIndexByUid: Retrieves the index of a column based on its unique identifier (UID). You can then use the getColumnByIndex method to retrieve the column object and modify its headerText property to change the header text.

  7. getColumnHeaderByUid: Retrieves the header element of a column based on its unique identifier (UID). You can modify the textContent property of the header element to change the header text. This method does not return a reference to the column object itself, only to the header element.If you only have an template for the column header, and the column itself is not defined with a field , then you can use the getColumnHeaderByUid method to get a reference to the header element and modify its text content to change the header text.

  • When you change the header text dynamically, you need to refresh the Grid to reflect the changes by calling the refreshHeader method.
  • The UID is automatically generated by the Grid component and may change whenever the grid is refreshed or updated.

Here is an example of how to change the header text of a column using the getColumnByField method:

@{
    ViewBag.dropDownData = new string[] { "OrderID", "CustomerID", "Freight", "OrderDate","ShipCountry" };
}
<div style="display: flex">
    <label style="padding: 3px 10px 0px 0;font-weight: bold;"> Select column name : </label>
    <span style="height:fit-content">
        <ejs-dropdownlist id="dropdown" index="0" dataSource="@ViewBag.dropDownData"></ejs-dropdownlist>
    </span>
</div>
<div style="padding:0px 0px 20px 0px">
    <label style="padding: 23px 4px 0 0;font-weight: bold;">Enter new header text :</label>
    <ejs-textbox id="textbox" placeholder="Enter new header text" width="220">
    </ejs-textbox>
    <ejs-button style="margin-left: 10px" id="buttons" content="Change">
    </ejs-button>
</div>
<ejs-grid id="Grid" dataSource="@ViewBag.DataSource" allowPaging="true">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<script type="text/javascript">
    document.getElementById('buttons').addEventListener('click', function () {
        var TextBoxValue = document.getElementById('textbox').value;
        var grid = document.getElementById("Grid").ej2_instances[0];
        if (TextBoxValue !== "") {
            const column = grid.getColumnByField(
                document.getElementById('dropdown').value
            );
            column.headerText = TextBoxValue;
            grid.refreshHeader();
        }
    });
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  ViewBag.dropdownData = new string[] { "OrderID", "CustomerID", "Freight", "OrderDate","ShipCountry" };
  return View();
}

public ActionResult Index()
{
  ViewBag.DataSource = OrdersDetails.GetAllRecords();
  return View();
}

Change header text dynamically

Changing the header text of all columns

If you want to change the header text of all columns in the grid, you can loop through the Columns collection of the grid and set the headerText property for each column. Here is an example:

<div style="padding:0px 0px 20px 0px">
    <ejs-button id="buttons" content="Change Header Text">
    </ejs-button>
</div>
<ejs-grid id="Grid" dataSource="@ViewBag.DataSource" >
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<script type="text/javascript">
    document.getElementById('buttons').addEventListener('click', function () {
        const headerTextMap = {
            OrderID: "Order ID",
            CustomerID: "Customer ID",
            Freight: "Freight Charge",
            ShipCountry: "Ship To Country",
        }
        var grid = document.getElementById("Grid").ej2_instances[0];
        grid.columnModel.forEach((column) => {
            column.headerText = headerTextMap[column.field];
        });
        grid.refreshHeader();

    });
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Changing the header text of all columns

Change the orientation of header text

By default, the text in the column headers of the Syncfusion® Grid control is oriented horizontally. However, in some cases, you may want to change the orientation of the header text to vertical, diagonal, or at a custom angle. This can be achieved by adding a custom CSS class to the column header cell using the customAttributes property of the Grid columns.

Follow the below steps to change the orientation of the header text in Grid:

Step 1: Create a CSS class with orientation style for grid header cell

To rotate the header text, you can create a CSS class with the transform property that rotates the header text 90 degrees. This class will be added to the header cell using the customAttributes property.

.orientationcss .e-headercelldiv {
    transform: rotate(90deg);
}

Step 2: Add the custom CSS class to the grid column

Once you have created the CSS class, you can add it to the particular column by using the customAttributes property. This property allows you to add any custom attribute to the grid column.

For example, to add the orientation class to the Freight column, you can use the following code:

    <e-grid-column field="Freight" headerText="Freight" customAttributes="@(new { @class="orientationcss" })" format='C' textAlign="Center" width="120"></e-grid-column>

Step 3: Resize the header cell height

After adding the custom CSS class to a column, you need to resize the header cell height so that the rotated header text is fully visible. You can do this by using the following code:

    function setHeaderHeight(args) {
        var textWidth = document.querySelector(".orientationcss > div").scrollWidth; // obtain the width of the headerText content.
        var headerCell = document.querySelectorAll(".e-headercell");
        for (var i = 0; i < headerCell.length; i++) {
            headerCell.item(i).style.height = textWidth + 'px'; // assign the obtained textWidth as the height of the headerCell.
        }
    }

The following example demonstrates how to change the orientation of the Freight column header text to 90 degrees:

<ejs-grid id="Grid" dataSource="@ViewBag.DataSource" created="setHeaderHeight">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" customAttributes="@(new { @class="orientationcss" })" format='C' textAlign="Center" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCity" headerText="Ship City" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<style>
    .orientationcss .e-headercelldiv {
        transform: rotate(90deg);
    }
</style>
<script>
    function setHeaderHeight(args) {
        var textWidth = document.querySelector(".orientationcss > div").scrollWidth; // obtain the width of the headerText content.
        var headerCell = document.querySelectorAll(".e-headercell");
        for (var i = 0; i < headerCell.length; i++) {
            headerCell.item(i).style.height = textWidth + 'px'; // assign the obtained textWidth as the height of the headerCell.
        }
    }
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Change the orientation of header text

Custom tooltip for header

Custom tooltips for headers provide additional information when hovering over a column header in the Syncfusion® Grid. This can be useful in situations where there is not enough space to display all of the information related to a column, or when there is additional context that may be helpful.

To enable custom tooltips for headers, you can use the BeforeRender event of the Grid component. This event is triggered for each header cell before it is rendered, allowing you to add a custom tooltip to the header cell using tooltip component.

Here’s an example of how to use the BeforeRender event to add a custom tooltip to a header cell:

<ejs-tooltip id="tooltip" position="TopCenter" target=".e-headertext" beforeRender="beforeRender">
    <e-content-template>
        <ejs-grid id="Grid" dataSource="@ViewBag.DataSource">
            <e-grid-columns>
                <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
                <e-grid-column field="Freight" headerText="Freight" format='C' textAlign="Center" width="120"></e-grid-column>
                <e-grid-column field="ShipName" headerText="Ship Name" width="120"></e-grid-column>
                <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
                <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
            </e-grid-columns>
        </ejs-grid>
    </e-content-template>
</ejs-tooltip>
<script>
    function beforeRender(args) {
        const columnDescriptions = {
            "Order ID": "A unique number assigned to each order.",
            "Freight": "The cost of shipping the order.",
            "Ship Name": "The name of the person or company who will receive the shipment.",
            "Ship Country": "The country to which the shipment will be sent.",
            "Order Date": "The date when the order was placed.",
        };
        var tooltip = document.getElementById("tooltip").ej2_instances[0];
        const headerText = args.target.innerText;
        const description = columnDescriptions[headerText];
        if (description) {
            tooltip.content = headerText + ": " + description;
        }
    }
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Custom tooltip for header

  • The headerCellInfo event can also be used to customize the header tooltip. This event is triggered for each header cell after it is rendered.

Customize header text styles

Customizing the grid header styles allows you to modify the appearance of the column header in the Grid control to meet your design requirements. You can customize the font, background color, and other styles of the header cells. To customize the header styles in the grid, you can use CSS, properties, methods, or event support provided by the Syncfusion® ASP.NET Core Grid component.

Using CSS

You can apply styles to the header cells using CSS selectors. The Grid provides a class name for each header cell element, which you can use to apply styles to that specific header cell. The .e-headercell class can be used to change the background color and text color of the column header.

  .e-grid .e-headercell {
    background-color: #a2d6f4;
    color:rgb(3, 2, 2);
  }

Here’s an example that demonstrates how to customize the appearance of a column header in the Grid using className.

<ejs-grid id="Grid" dataSource="@ViewBag.DataSource">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<style>
    .e-grid .e-headercell {
        background-color: #a2d6f4;
        color: rgb(3, 2, 2);
    }
</style>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Display HTML content

Using property

You can customize the appearance of the column headers in Grid using the customAttributes property. The customAttributes property takes an object with the name-value pair to customize the CSS properties for grid header cells. You can also set multiple CSS properties to the custom class using the customAttributes property.

To customize the header of a column, you can follow the steps below:

Step 1: Define a CSS class that specifies the styles you want to apply to the header cell of the column. For example, to change the background color and text color of the header cell, define a CSS class like this:

    .e-grid .e-headercell.custom {
       background-color: rgb(43, 205, 226);
       color: black;
    }

Step 2: Set the customAttributes property of the desired column to an object that contains the CSS class custom. This CSS class will be applied to the header cell of the specified column in the Grid.

    <e-grid-column field="Freight" headerText="Freight" customAttributes="@(new { @class="custom" })" format='C' textAlign="Right" width="120"></e-grid-column>

The following example demonstrates how to customize the appearance of the OrderID and OrderDate columns using custom attributes.

<ejs-grid id="Grid" dataSource="@ViewBag.DataSource">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' customAttributes="@(new { @class="custom" })" width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" customAttributes="@(new { @class="custom" })" format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" customAttributes="@(new { @class="custom" })" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<style>
    .e-grid .e-headercell.custom {
        background-color: rgb(43, 195, 226);
        color: rgb(10, 8, 8);
    }
    .e-grid .e-headercell {
        background-color: #a2d6f4;
    }
</style>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Using property

Using method

The Syncfusion® Grid provides methods to customize the appearance of the grid columns header.

  1. getColumnHeaderByIndex: The method is used to customize the appearance of a specific column header in the grid by specifying the index of the column for which you want to customize the header.

  2. getColumnHeaderByField: This method is used to retrieve the header element of a specific column by its field name. You can use the retrieved element to customize the appearance of the header element.

  3. getColumnHeaderByUid: This method is used to retrieve the header element of a specific column by its unique ID. You can use the retrieved element to customize the appearance of the header element.

  4. getColumnIndexByField:This method is used to retrieve the index of a specific column by its field name. You can use the retrieved index to access the header element and customize its appearance.

  5. getColumnIndexByUid: This method is used to retrieve the index of a specific column by its unique ID. You can use the retrieved index to access the header element and customize its appearance.

Here’s an example of how to use these methods to change the style of a specific column header:

<ejs-grid id="Grid" dataSource="@ViewBag.DataSource" dataBound="dataBound" height="320">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight"  format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<script>
    function dataBound(args) {
        var grid = document.getElementById("Grid").ej2_instances[0];
        grid.getColumnHeaderByIndex(0).style.color = 'green';
        grid.getColumnHeaderByField('CustomerID').style.background = 'rgb(217, 244, 235)';
        grid.getColumnHeaderByField('OrderID').style.background = 'rgb(217, 244, 235)';
        grid.getColumnHeaderByField('ShipCountry').style.background = 'rgb(217, 244, 235)';
        grid.getColumnHeaderByField('CustomerID').style.color = 'green';
        grid.getColumnHeaderByUid('grid-column2').style.background = 'rgb(217, 244, 235)';
        const columnIndex = grid.getColumnIndexByField('ShipCountry');
        grid.getColumnHeaderByIndex(columnIndex).style.color = 'green';
        const index = grid.getColumnIndexByUid('grid-column2');
        grid.getColumnHeaderByIndex(index).style.color = 'green';
    }
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Using method

  • The UID is automatically generated by the Grid component and may change whenever the grid is refreshed or updated.

Using event

To customize the appearance of the grid header, you can handle the headerCellInfo event of the grid. This event is triggered when each header cell is rendered in the grid, and provides an object that contains information about the header cell. You can use this object to modify the styles of the header column.

The following example demonstrates how to add a headerCellInfo event handler to the grid. In the event handler, checked whether the current header column is Order Date field and then applied the appropriate CSS class to the cell based on its value.

<ejs-grid id="Grid" dataSource="@ViewBag.DataSource" allowPaging="true" headerCellInfo="onHeaderCellInfo">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
<style>
    .e-grid .e-headercell.customcss {
        color: rgb(14, 10, 10);
        background-color: #52c5dcab;
    }
</style>
<script>
    function onHeaderCellInfo(args) {
        if (args.cell.column.field == "OrderDate")
            args.node.classList.add("customcss");
    }
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

Using event

How to refresh header

The refresh header feature in the Syncfusion® ASP.NET Core Grid allows you to update the header section of the grid whenever changes are made to the grid’s columns. This feature is useful when you want to reflect changes in the header immediately, such as modifying the column header text, width, or alignment.

To use the refresh header feature, you can call the refreshHeader method of the Grid component. This method updates the grid header with the latest changes made to the columns.

The following example demonstrates how to use the refreshHeader method to update the grid header:

<ejs-button id="button" content="Refresh Header"></ejs-button>
<div style='padding:20px 0px 0px 0px'>
<ejs-grid id="Grid" dataSource="@ViewBag.DataSource">
    <e-grid-columns>
        <e-grid-column field='OrderID' headerText='Order ID' textAlign='Right' width=120></e-grid-column>
        <e-grid-column field="CustomerID" headerText="Customer ID" width="130"></e-grid-column>
        <e-grid-column field="Freight" headerText="Freight" format='C' textAlign="Right" width="120"></e-grid-column>
        <e-grid-column field="OrderDate" headerText="Order Date" textAlign="Right" type='date' format="yMd" width="130"></e-grid-column>
        <e-grid-column field="ShipCountry" headerText="Ship Country" width="120"></e-grid-column>
    </e-grid-columns>
</ejs-grid>
</div>
<script>
    document.getElementById('button').addEventListener('click', function () {
        var grid = document.getElementById("Grid").ej2_instances[0];
        const column = grid.getColumnByField("CustomerID");
        column.headerText = "New Header Text"; // update the header text of the column object
        grid.refreshHeader();
    
    });
</script>
public IActionResult Index()
{
  var orders = OrdersDetails.GetAllRecords();
  ViewBag.DataSource = orders;
  return View();
}

How to refresh header

  • The refreshHeader method updates only the grid header and not the entire grid.
  • If you want to refresh the entire grid, you can use the refresh method instead.

How to get header element

To get the header element in a Syncfusion® Grid, you can use one of the following methods:

  1. getHeaderContent: This method returns the header div element of the Grid. You can use this method to access the entire header content of the Grid.

     var grid = document.getElementById("Grid").ej2_instances[0]
 const headerTableElement=grid.getHeaderContent();

  2. getHeaderTable: This method returns the header table element of the Grid. You can use this method to access only the header table of the Grid.

     var grid = document.getElementById("Grid").ej2_instances[0]
 const headerTableElement = grid.getHeaderTable();

  3. getColumnHeaderByUid: This method returns the column header element by its unique identifier.

     var grid = document.getElementById("Grid").ej2_instances[0]
 const columnHeaderElement = grid.getColumnHeaderByUid("e-grid2");

  4. getColumnHeaderByIndex: This method returns the column header element by its index.

     var grid = document.getElementById("Grid").ej2_instances[0]
 const columnHeaderElement = grid.getColumnHeaderByIndex(0);

  5. getColumnHeaderByField: This method returns the column header element by its field name.

     var grid = document.getElementById("Grid").ej2_instances[0]
 const columnHeaderElement = grid.getColumnHeaderByField("OrderID");
  • The UID is automatically generated by the Grid component and may change whenever the grid is refreshed or updated.