OnBeforeDisplayToolTip Method

Notifies this instance that a tooltip is about to be displayed.

Syntax

Visual Basic

'Declaration
 
Protected Overridable Function OnBeforeDisplayToolTip( _
   ByVal ultraControl As IUltraControl, _
   ByVal element As UIElement, _
   ByRef toolTipInfo As ToolTipInfo, _
   ByVal trigger As ControlUIElementBase.ToolTipTrigger _
) As Boolean

C#

protected virtual bool OnBeforeDisplayToolTip( 
   IUltraControl ultraControl,
   UIElement element,
   ref ToolTipInfo toolTipInfo,
   ControlUIElementBase.ToolTipTrigger trigger
)

Parameters

ultraControl

The IUltraControl interface implementor for which the tooltip is being displayed.

element

The UIElement for which the tooltip is being displayed.

toolTipInfo

The ToolTipInfo struct containing information about the tooltip.

trigger

Specifies the event that triggered the tooltip, i.e., a MouseHover or MouseEnter notification.

Return Value

A boolean indicating whether the tooltip should be displayed.

Remarks

The default implementation returns true unconditionally. This method can be overridden for the purpose of receiving a notification immediately before a tooltip is about to be displayed.

Note: The toolTipInfo structure is passed by reference to prevent a memberwise copy from being made, in the interest of conserving memory; however, no properties of this structure should be modified.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2