Grid tooltip not using correct DataAnnotation.

Hey there.

The description of DataAnnotations within a data grid, as described here indicated that if the Description annotation is used, then that value will be used as the Tooltip when the user hovers over the column header.

Currently this does not appear to be working as intended; it's using the 'Name' annotation instead.

If you would like to see an example of this, please look at the code included on the same page (you will need to add ShowTooltip="true" to the SfGrid tag.)  The tooltip pulls the "Name" annotation, not the "Description" annotation.

For clarity, I'm currently using version 31.1.23.

Any thoughts?  Is this already an open ticket?

Thanks for your time.


4 Replies

NP Naveen Palanivel Syncfusion Team October 23, 2025 12:43 PM UTC

Hi Christopher,

We would like to inform you how the Description data annotation attribute works in the grid. When the column header text is too long and gets truncated, it shows an ellipsis (…). In such cases, the description text appears as a tooltip when you hover over the ellipsis. You do not need to set ShowTooltip="true" on the SfGrid tag. The tooltip is automatically shown when the header text exceeds the column width and is truncated.

Sample : https://blazorplayground.syncfusion.com/hDByWDhKzKZLFHYj



Regards,
Naveen



CH Christopher October 23, 2025 03:01 PM UTC

Thanks for getting back, although that is disappointing news.  


I was hoping for descriptive text - deriving from the Display -> Description annotation on the field of the class -  that appears as a tooltip on the column header regardless of whether or not it was truncated.  To be perfectly honest, if a tooltip was only to appear when the column header is truncated, why not automatically use the Display -> Name annotation? If the Description annotation is there to provide more information than the Name, why not make it available in all cases?


The behaviour is even more disappointing when creating a grid that uses complex binding, as I'm forced to configure the GridColumn Field entry as "Child.Field" in the GridColumn definition, in which case NO annotation values are used whatsoever: not from the child class itself, or any of the fields within that class, whether the field is truncated or not.


Anyway, thanks for checking.



VN Vignesh Natarajan Syncfusion Team October 28, 2025 05:00 PM UTC

HI Christopher


We understand your query and currently we are checking the feasibilities. We will update you further details by 30th October 2025.  We appreciate your patience. 


Regards,
Vignesh Natarajan



SK Sanjay Kumar Suresh Syncfusion Team October 30, 2025 01:08 PM UTC

Hi Christopher,


By default, the Syncfusion Blazor DataGrid displays tooltips for header text only when the content is visually truncated. This behavior is by design to prevent unnecessary tooltip clutter when the full header text is already visible.


Additionally, if the column includes a Description attribute, the Grid will display that description as the tooltip content—but again, only when the header text is truncated. This ensures that tooltips are shown contextually and do not interfere with the readability of fully visible headers.


To display data annotation on complex columns we have a separate sample documented, please check the below link.


Reference:

https://blazor.syncfusion.com/documentation/datagrid/column-validation?cs-save-lang=1&cs-lang=razor


Regards,

Sanjay Kumar Suresh


Loader.
Up arrow icon