ToolTipControllerGetActiveObjectInfoEventArgs.Info Property

Gets or sets an object which uniquely identifies the visual element at the current position.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v19.2.dll

Declaration

C#

public ToolTipControlInfo Info { get; set; }

VB.NET

Public Property Info As ToolTipControlInfo

Property Value

Type	Description
ToolTipControlInfo	A ToolTipControlInfo object which identifies the visual element at the current position.

Remarks

The ToolTipController.GetActiveObjectInfo event is called repeatedly when the mouse cursor moves over a control. To display a hint for the control’s specific element, check the current mouse position and if the mouse hovers over the required element assign a ToolTipControlInfo object containing tooltip information to the event’s Info parameter. The ToolTipControlInfo.Text property must specify the hint to display. The ToolTipControlInfo.Object property must be set to a value that uniquely identifies the current element.

The value of the ToolTipControlInfo.Object property is used as an identifier. To display different tooltips for a control’s elements, different ToolTipControlInfo objects with different values of the ToolTipControlInfo.Object properties must be used. If you assign the same ToolTipControlInfo object to the Info parameter as in the previous event call the tooltip will not be redisplayed even if a new tooltip text is specified.

If you assign a new ToolTipControlInfo object but the object assigned to the ToolTipControlInfo.Object property is the same as in the previous event call, the tooltip will not be redisplayed either. If you assign a new ToolTipControlInfo object to the parameter and change the ToolTipControlInfo.Object property as compared to the previous event call, the previous hint will be hidden and the new hint will be displayed.

Example

The following example demonstrates a way of implementing custom tooltips for row indicator cells in the XtraGrid control. By default, the grid control does not support tooltips for row indicator cells. To provide tooltips, drop the ToolTipController component onto the grid’s form, assign it to the grid control’s EditorContainer.ToolTipController property and handle the ToolTipController.GetActiveObjectInfo event.

In our example, the tooltips will display the “Row N” text where N is the ordinal number of a row.

C#

using DevExpress.Utils;
using DevExpress.XtraGrid.Views.Grid;
using DevExpress.XtraGrid.Views.Grid.ViewInfo;
//...
private void toolTipController1_GetActiveObjectInfo(object sender, 
ToolTipControllerGetActiveObjectInfoEventArgs e) {
    if(e.SelectedControl != gridControl1) return;

    ToolTipControlInfo info = null;
    //Get the view at the current mouse position
    GridView view = gridControl1.GetViewAt(e.ControlMousePosition) as GridView;
    if(view == null) return;
    //Get the view's element information that resides at the current position
    GridHitInfo hi = view.CalcHitInfo(e.ControlMousePosition);
    //Display a hint for row indicator cells
    if(hi.HitTest == GridHitTest.RowIndicator) {
        //An object that uniquely identifies a row indicator cell
        object o = hi.HitTest.ToString() + hi.RowHandle.ToString();
        string text = "Row "+ hi.RowHandle.ToString();
        info = new ToolTipControlInfo(o, text);         
    }
    //Supply tooltip information if applicable, otherwise preserve default tooltip (if any)
    if (info != null)
        e.Info = info;
}

VB.NET

Imports DevExpress.XtraGrid.Views.Grid
Imports DevExpress.XtraGrid.Views.Grid.ViewInfo

Private Sub ToolTipController1_GetActiveObjectInfo(ByVal sender As Object, _ 
ByVal e As DevExpress.Utils.ToolTipControllerGetActiveObjectInfoEventArgs) _
Handles ToolTipController1.GetActiveObjectInfo
    If Not e.SelectedControl Is gridControl1 Then Return

    Dim info As ToolTipControlInfo = Nothing
    'Get the view at the current mouse position
    Dim view As GridView = gridControl1.GetViewAt(e.ControlMousePosition)
    If view Is Nothing Then Return
    'Get the view's element information that resides at the current position
    Dim hi As GridHitInfo = view.CalcHitInfo(e.ControlMousePosition)
    'Display a hint for row indicator cells
    If hi.HitTest = GridHitTest.RowIndicator Then
        'An object that uniquely identifies a row indicator cell
        Dim o As Object = hi.HitTest.ToString() + hi.RowHandle.ToString()
        Dim text As String = "Row " + hi.RowHandle.ToString()
        info = New ToolTipControlInfo(o, text)
    End If
    'Supply tooltip information if applicable, otherwise preserve default tooltip (if any)
    If Not info Is Nothing Then e.Info = info
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Info 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-obtain-information-about-a-hovered-grid-element-t191106/CS/dxSample/XtraForm1.cs#L37

    DevExpress.XtraGrid.Drawing.GridColumnInfoArgs columnInfo = viewInfo.ColumnsInfo[hi.Column];
    e.Info = new DevExpress.Utils.ToolTipControlInfo(hi.Column, string.Format("'{0}'; left coord:{1}", columnInfo.Caption, columnLeftCoord));
}

winforms-grid-forcibly-show-cell-tooltips/CS/AlwaysShowCellHints/Form1.cs#L21

private void toolTipController1_GetActiveObjectInfo(object sender, ToolTipControllerGetActiveObjectInfoEventArgs e) {
    if(e.Info == null && e.SelectedControl == gridControl1) {
        GridView view = gridControl1.FocusedView as GridView;

how-to-add-the-capability-to-insert-comments-to-xtragrid-cells-like-in-ms-excel-e2113/CS/WinFormsExample/Form1.cs#L107

private void toolTipController1_GetActiveObjectInfo(object sender, DevExpress.Utils.ToolTipControllerGetActiveObjectInfoEventArgs e) {
    if(e.Info != null) return;
    string columnName = String.Empty;

custom-editor-how-to-create-a-fileedit-e4097/CS/CustomEditor/FileEdit.cs#L39

if (info != null)
    e.Info = info;

how-to-use-a-custom-usercontrol-as-a-tooltip-e4533/CS/ToolTipControllerExample/Main.cs#L25

if(hitInfo.HitInfoType == HitInfoType.Cell) {
    e.Info = new ToolTipControlInfo();
    e.Info.Object = $"Column={hitInfo.Column.FieldName}, NodeId={hitInfo.Node.Id}";

VB.NET

how-to-obtain-information-about-a-hovered-grid-element-t191106/VB/dxSample/XtraForm1.vb#L40

    Dim columnInfo As DevExpress.XtraGrid.Drawing.GridColumnInfoArgs = viewInfo.ColumnsInfo(hi.Column)
    e.Info = New DevExpress.Utils.ToolTipControlInfo(hi.Column, String.Format("'{0}'; left coord:{1}", columnInfo.Caption, columnLeftCoord))
End If

winforms-grid-forcibly-show-cell-tooltips/VB/AlwaysShowCellHints/Form1.vb#L23

Private Sub toolTipController1_GetActiveObjectInfo(ByVal sender As Object, ByVal e As ToolTipControllerGetActiveObjectInfoEventArgs) Handles toolTipController1.GetActiveObjectInfo
    If e.Info Is Nothing AndAlso e.SelectedControl Is gridControl1 Then
        Dim view As GridView = TryCast(gridControl1.FocusedView, GridView)

how-to-provide-supertooltip-with-design-time-support-for-any-control-e2311/VB/E2311/Helper/MyNavBarSuperTipHelper.vb#L36

Dim superTip As SuperToolTip = GetSuperTipByGroup(hi.Group)
    If e.Info Is Nothing Then
        e.Info = New ToolTipControlInfo(e.SelectedControl, "")

how-to-add-the-capability-to-insert-comments-to-xtragrid-cells-like-in-ms-excel-e2113/VB/WinFormsExample/Form1.vb#L111

Private Sub toolTipController1_GetActiveObjectInfo(ByVal sender As Object, ByVal e As DevExpress.Utils.ToolTipControllerGetActiveObjectInfoEventArgs) Handles toolTipController1.GetActiveObjectInfo
    If e.Info IsNot Nothing Then
        Return

custom-editor-how-to-create-a-fileedit-e4097/VB/CustomEditor/FileEdit.vb#L43

If info IsNot Nothing Then
    e.Info = info
End If