GridColumn.ToolTip Property

Gets or sets a column hint.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DXCategory("Appearance")]
[DefaultValue("")]
[XtraSerializableProperty]
public virtual string ToolTip { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue("")>
<XtraSerializableProperty>
Public Overridable Property ToolTip As String

Property Value

Type	Default	Description
String	String.Empty	A custom tooltip for the column.

Remarks

When the View’s GridOptionsHint.ShowColumnHeaderHints option is set to true, column headers can show tooltips. The default tooltip is equal to the column’s caption (GridColumn.Caption). It shows non-trimmed, even if the caption itself is trimmed. To see a tooltip, users need to position their mouse pointer over the column’s header.

The code sample below illustrates how to add a custom tooltip to a grid column.

C#

gridView1.Columns["productPrice"].ToolTip = "Price of the product per item";

VB.NET

gridView1.Columns("productPrice").ToolTip = "Price of the product per item"

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ToolTip property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-implement-the-accessible-named-grid-row-e552/CS/WindowsApplication210/CGrid.cs#L132

{
    string str = (this.Column.GetTextCaption() == "") ? this.Column.ToolTip : this.Column.GetTextCaption();
    string rowName = ((IAccessibleGrid)this.View).GetRow(((CGridView)this.View).RowHandle2AccessibleIndex(this.RowHandle)).GetName();

VB.NET

how-to-implement-the-accessible-named-grid-row-e552/VB/WindowsApplication210/CGrid.vb#L145

If (Me.Column.GetTextCaption() = "") Then
    str = Me.Column.ToolTip
Else