Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Collapse]DevExpress.Utils
   [Expand]AppearanceObject Class
   [Expand]AppearanceObjectEx Class
   [Expand]AppearanceOptions Class
   [Expand]AppearanceOptionsEx Class
   [Expand]BaseAppearanceCollection Class
   [Expand]CheckContextButton Class
   [Expand]ContextButton Class
   [Expand]ContextButtonBase Class
   [Expand]ContextItem Class
   [Expand]DefaultToolTipController Class
   [Expand]DPIAwareImageCollection Class
   [Expand]DXMouseEventArgs Class
    EditorShowMode Enumeration
   [Expand]FlyoutPanel Class
   [Expand]FlyoutPanelButtonOptions Class
   [Expand]FlyoutPanelOptions Class
    GroupElementLocation Enumeration
   [Expand]HideException Class
    HKeyPrefix Enumeration
   [Expand]ImageCollection Class
   [Expand]Images Class
   [Expand]KeyShortcut Class
    Locations Enumeration
   [Expand]MagnifierDialog Class
   [Expand]MagnifierDialogArgs Class
   [Expand]MagnifierDialogResult Structure
   [Expand]RatingContextButton Class
   [Expand]SharedImageCollection Class
    SharedImageCollectionImageSizeMode Enumeration
   [Expand]SuperToolTip Class
   [Expand]SvgImageCollection Class
   [Expand]TextOptions Class
   [Expand]ThumbnailImageEventArgs Class
   [Expand]ToolTipControlInfo Class
   [Collapse]ToolTipController Class
     ToolTipController Members
    [Expand]ToolTipController Constructor
    [Expand]ToolTipController Properties
    [Collapse]ToolTipController Events
      BeforeShow Event
      CalcSize Event
      CustomDraw Event
      GetActiveObjectInfo Event
      HyperlinkClick Event
    [Expand]ToolTipController Methods
    ToolTipControllerBeforeShowEventHandler Delegate
   [Expand]ToolTipControllerCalcSizeEventArgs Class
    ToolTipControllerCalcSizeEventHandler Delegate
   [Expand]ToolTipControllerCustomDrawEventArgs Class
    ToolTipControllerCustomDrawEventHandler Delegate
   [Expand]ToolTipControllerEventArgsBase Class
   [Expand]ToolTipControllerGetActiveObjectInfoEventArgs Class
    ToolTipControllerGetActiveObjectInfoEventHandler Delegate
   [Expand]ToolTipControllerShowEventArgs Class
    ToolTipIconSize Enumeration
    ToolTipIconType Enumeration
   [Expand]ToolTipItem Class
    ToolTipLocation Enumeration
    ToolTipStyle Enumeration
    ToolTipType Enumeration
   [Expand]TrackBarContextButton Class
    Trimming Enumeration
   [Expand]WorkspaceManager Class
    XPThemeSupport Enumeration
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

ToolTipController.GetActiveObjectInfo Event

Allows you to provide custom tooltips for any element of a control that implements the DevExpress.Utils.IToolTipControlClient interface.

Namespace:DevExpress.Utils
Assembly:DevExpress.Utils.v17.2.dll

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type ToolTipControllerGetActiveObjectInfoEventArgs containing data related to this event.

The following ToolTipControllerGetActiveObjectInfoEventArgs properties provide information specific to this event.
Property Description
ControlMousePosition Gets the position of the mouse cursor relative to the control's upper left corner.
Info Gets or sets an object which uniquely identifies the visual element at the current position.
SelectedControl Gets or sets the control for which a tooltip controller's event is fired.
SelectedObject Gets or sets the element of the control for which the tooltip should be displayed.

Expanded Remarks

DevExpress controls that need to support tooltips for their elements implement the DevExpress.Utils.IToolTipControlClient interface. For instance, the Grid Control implements this interface to display hints for its elements (column and band headers and cells). For other elements, tooltips are not displayed by default.

To enable tooltips for any element of a control that implements the DevExpress.Utils.IToolTipControlClient interface, you need to handle the GetActiveObjectInfo event. This event is fired when you move the mouse cursor over the control. To provide a tooltip for the control's element, assign a ToolTipControlInfo object containing tooltip information to the event's ToolTipControllerGetActiveObjectInfoEventArgs.Info parameter. The event's ToolTipControllerGetActiveObjectInfoEventArgs.ControlMousePosition parameter specifies the position of the mouse cursor relative to the control's upper left corner.

A ToolTipControlInfo object that is assigned to the event's ToolTipControllerGetActiveObjectInfoEventArgs.Info parameter must provide tooltip information. The ToolTipControlInfo.Text must specify the tooltip text. The ToolTipControlInfo.Object property must uniquely identify the currently processed element. Other properties of the ToolTipControlInfo class can be used to specify the tooltip's title, icon type and delay.

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.

You can also handle the BeforeShow event to customize the tooltip just prior to it being displayed onscreen.

Expanded 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 GetActiveObjectInfo event.

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

Expanded See Also

How would you rate this topic?​​​​​​​