BaseControl.ToolTipController Property

Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for this control.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DXCategory("Appearance")]
[DefaultValue(null)]
public ToolTipController ToolTipController { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue(Nothing)>
Public Property ToolTipController As ToolTipController

Property Value

Type	Default	Description
ToolTipController	*null*	The ToolTipController component controlling the appearance and behavior of hints displayed for this control.

Remarks

The availability and content of hints displayed for controls can be controlled by the BaseControl.ToolTip, BaseControl.SuperTip and BaseControl.ShowToolTips properties. By default, hints display only the specified text, and have the default shape and appearance. The content, appearance and behavior of tooltips can be customized using tooltip controllers.

By default, the ToolTipController property is set to null, and the control’s tooltips are handled by the Default ToolTipController, which is available via the DefaultToolTipController component. Changing this object’s properties and handling its events, affect hints displayed for all controls whose ToolTipController property is set to null.

To make a control’s tooltips handled by a specific tooltip controller, add a ToolTipController component to the form and assign it to the control’s BaseControl.ToolTipController property.

Please refer to Tooltip Management for details.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ToolTipController 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-provide-the-capability-to-show-tooltips-for-lookupedit-items-e3040/CS/LookUpEditWithHints/PopupLookUpEditHintsForm.cs#L23

public PopupLookUpEditHintsForm(LookUpEditHints ownerEdit) : base(ownerEdit) {
    if (this.OwnerEdit.ToolTipController == null)
        tt = ToolTipController.DefaultController;

how-to-make-tool-tips-appear-immediately-after-validation-is-failed-e2452/CS/ValidationProviderAutoTooltips/Form1.cs#L26

if ( edit.ToolTipController == null )
    edit.ToolTipController = new ToolTipControllerDefault();

how-to-display-a-hint-for-an-active-editor-within-the-xtragrid-e749/CS/WindowsApplication1/Form1.cs#L28

DevExpress.XtraGrid.Views.Grid.GridView gridView = sender as DevExpress.XtraGrid.Views.Grid.GridView;
if (gridView.ActiveEditor.ToolTipController != null)
{

VB.NET

how-to-provide-the-capability-to-show-tooltips-for-lookupedit-items-e3040/VB/LookUpEditWithHints/PopupLookUpEditHintsForm.vb#L24

MyBase.New(ownerEdit)
If Me.OwnerEdit.ToolTipController Is Nothing Then
    tt = ToolTipController.DefaultController

how-to-make-tool-tips-appear-immediately-after-validation-is-failed-e2452/VB/ValidationProviderAutoTooltips/Form1.vb#L26

If edit.ToolTipController Is Nothing Then
    edit.ToolTipController = New ToolTipControllerDefault()

how-to-display-a-hint-for-an-active-editor-within-the-xtragrid-e749/VB/WindowsApplication1/Form1.vb#L25

Dim gridView As DevExpress.XtraGrid.Views.Grid.GridView = TryCast(sender, DevExpress.XtraGrid.Views.Grid.GridView)
If gridView.ActiveEditor.ToolTipController IsNot Nothing Then
    AddHandler gridView.ActiveEditor.ToolTipController.GetActiveObjectInfo, AddressOf ToolTipController_GetActiveObjectInfo