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
 [Collapse]Common Features
  [Expand]Data Binding Common Concepts
  [Expand]Data Source Wizard
  [Expand]Expressions
  [Expand]Behaviors
  [Expand]Application Appearance
  [Expand]Filtering UI Context
  [Expand]High DPI Support
  [Expand]Scaffolding Wizard
  [Expand]Formatting Values
   HTML Text Formatting
  [Expand]Menus
  [Collapse]Tooltip Management
    How to: Customize Tooltips for XtraGrid and CheckBox Using the ToolTipController
    How to: Customize Tooltips Using the Default ToolTipController
    How to: Add Tooltips for the Row Indicator in XtraGrid
    How to: Create SuperToolTips In Code
    ToolTipController Component
    ToolTip Types
    Setting ToolTips for DevExpress Controls
    Setting ToolTips for Third-Party Controls
    Creating SuperToolTips
    Hyperlinks in Tooltips
  [Expand]Saving and Restoring Layouts
   Clipboard - Copy and Paste Operations. Data Formatting
   Version Compatibility: Default Property Values
  Get More Help
 [Expand]API Reference
[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 Component

The ToolTipController component provides centralized management for the appearance and behavior of hints in DevExpress controls and any other controls. The functionality of the tooltip controller is encapsulated by the ToolTipController class. This topic provides general information on the ToolTipController component and lists the main settings that affect tooltip appearance.

Expanded ToolTip Controller

The ToolTipController provides properties that allow the appearance and behavior settings of tooltips to be customized. The ToolTipController component must be bound to a control in order to enable tooltip management. So if multiple controls are bound to the same ToolTipController, they will all have the same look-and-feel and behavior.

Note

DevExpress controls do not necessarily need to be bound to a ToolTipController component. If they are not bound to a ToolTipController, the tooltips for these controls are handled by the static Default ToolTipController. See the section below for more information.

Usually a tooltip's contents (title, text and icon) are determined by the control that the tooltip is displayed for. However, ToolTipController exposes the events to dynamically customize the contents and appearance of tooltips for any control and control's element.

The following table lists the main properties and events declared in the ToolTipController class.

Property, event Description
ToolTipController.Appearance Specifies the appearance settings for tooltips.
ToolTipController.AppearanceTitle Contains the appearance settings of a tooltip's title.
ToolTipController.AutoPopDelay The time interval specifying how long a tooltip is displayed for.
ToolTipController.IconSize Specifies the size of the icon displayed within a tooltip.
ToolTipController.InitialDelay Specifies the time lapse between placing the cursor on a visual element and a tooltip being displayed.
ToolTipController.Rounded Specifies whether a tooltip's corners are rounded or not.
ToolTipController.RoundRadius Specifies the radius of a tooltip's rounded corners.
ToolTipController.ShowBeak Specifies whether callout beaks are displayed for hints or not.
ToolTipController.ShowShadow Specifies whether tooltips are shown shadowed.
ToolTipController.ToolTipLocation Specifies a tooltip's location.
ToolTipController.BeforeShow Enables you to customize the text and settings of a tooltip before displaying it onscreen.
ToolTipController.CalcSize Enables you to specify the position and size of a tooltip's window.
ToolTipController.CustomDraw Enables you to custom paint a tooltip's region.

Expanded Default ToolTip Controller

It is not necessary to place a ToolTipController component onto a form and bind it to controls in order to enable hint customization and management. Instead you can use the Default ToolTipController component that manages tooltips for any control by default. In code, the Default ToolTipController can be accessed via the static ToolTipController.DefaultController property. To access it at design time, place the DefaultToolTipController component onto a form.

You can customize the settings and subscribe to events of the Default ToolTipController in the same manner as for the regular ToolTipController component.

A note for the DevExpress controls and components that provide the ToolTipController property: if this property is set to an instance of the ToolTipController type, the tooltips for this control will be handled by the assigned ToolTipController and not by the Default ToolTipController.

Expanded Scenarios of Using the ToolTip Controller

The following table lists the common scenarios to customize tooltips for controls.

Task Scenario(s)
Provide centralized management for tooltips for all controls within an application. Use the Default ToolTipController.
Customize tooltips differently for different controls. - Assign different ToolTipController components to different controls. The Default ToolTipController can be used to handle tooltips for the controls whose ToolTipController properties are not set.

- Use a single ToolTipController component for all controls and handle its events to customize tooltips dynamically.

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