ToolTipControlInfo.Object Property

Gets or sets an object which uniquely identifies the currently processed element.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v19.1.dll

Declaration

C#

public object Object { get; set; }

VB.NET

Public Property Object As Object

Property Value

Type	Description
Object	An object which uniquely identifies the currently processed element.

Remarks

See the ToolTipController.GetActiveObjectInfo topic for more information.

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 Object 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-show-tooltips-for-elements-of-my-custom-control-e2689/CS/WindowsApplication1/CustomControl.cs#L94

ToolTipControlInfo info = new ToolTipControlInfo();
info.Object = hintText;
info.Text = hintText;

xtratabbedmdimanager-how-to-display-thumbnails-for-mdi-child-forms-e2581/CS/WindowsApplication1/Helper/ThumbnailHintHelper.cs#L36

toolTip.Interval = 500;
toolTip.Object = page;
SuperToolTip superTip = new SuperToolTip();

how-to-show-separate-tool-tips-for-values-shown-in-the-checkedcomboboxedits-edit-box-e2637/CS/WindowsApplication3/Form1.cs#L138

ToolTipControlInfo tInfo = tInfo = new ToolTipControlInfo();
tInfo.Object = itemIndex;
tInfo.SuperTip = GetSuperToolTip(checkedComboBoxEdit1, (carsBindingSource.DataSource as DataTable).Rows[itemIndex]);

how-to-find-an-element-located-under-the-mouse-cursor-in-master-and-detail-views-e2451/CS/Form1.cs#L109

e.Info = new ToolTipControlInfo();
e.Info.Object = hi.Column;
e.SelectedObject = hi.Column;

how-to-show-a-tooltip-in-the-datenavigator-control-e471/CS/Form1.cs#L45

ttci.Interval = 500;
ttci.Object = date;

VB.NET

how-to-show-tooltips-for-elements-of-my-custom-control-e2689/VB/WindowsApplication1/CustomControl.vb#L86

Dim info As New ToolTipControlInfo()
info.Object = hintText
info.Text = hintText

xtratabbedmdimanager-how-to-display-thumbnails-for-mdi-child-forms-e2581/VB/WindowsApplication1/Helper/ThumbnailHintHelper.vb#L33

toolTip.Interval = 500
toolTip.Object = page
Dim superTip As New SuperToolTip()

how-to-show-separate-tool-tips-for-values-shown-in-the-checkedcomboboxedits-edit-box-e2637/VB/WindowsApplication3/Form1.vb#L128

Dim tInfo As ToolTipControlInfo = New ToolTipControlInfo()
tInfo.Object = itemIndex
tInfo.SuperTip = GetSuperToolTip(checkedComboBoxEdit1, CType(carsBindingSource.DataSource, DataTable).Rows(itemIndex))

how-to-find-an-element-located-under-the-mouse-cursor-in-master-and-detail-views-e2451/VB/Form1.vb#L117

e.Info = New ToolTipControlInfo()
e.Info.Object = hi.Column
e.SelectedObject = hi.Column

how-to-show-a-tooltip-in-the-datenavigator-control-e471/VB/Form1.vb#L41

ttci.Interval = 500
ttci.Object = [date]