'Declaration Public Event LocationToolTipDisplaying As LocationToolTipDisplayingHandler
public event LocationToolTipDisplayingHandler LocationToolTipDisplaying
The event handler receives an argument of type LocationToolTipDisplayingEventArgs containing data related to this event. The following LocationToolTipDisplayingEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Cancel (Inherited from System.ComponentModel.CancelEventArgs) | |
| ElementKind | Returns the Infragistics.Win.Misc.LocationElementKind constant which identifies the user interface element for which the tooltip will be displayed, i.e., a Infragistics.Win.Misc.LocationTextButtonUIElement, Infragistics.Win.Misc.LocationDropDownButtonUIElement, or Infragistics.Win.Misc.LocationListItemUIElement. |
| IsTextFullyVisible | Returns whether the text being displayed by the location is fully visible. |
| Location | Returns the Infragistics.Win.Misc.UltraNavigationBarLocation with which this instance is associated. |
| ScreenLocation (Inherited from Infragistics.Win.Misc.UltraWinNavigationBar.ToolTipDisplayingEventArgs) | Gets/sets the location at which the tooltip will be displayed, expressed in screen coordinates. |
| ToolTipText | Gets/sets the string that is displayed in the location's tooltip. |
The LocationToolTipDisplaying event fires whenever the cursor hovers over the LocationTextButtonUIElement or LocationListItemUIElement. If the UltraNavigationBarLocation's UltraNavigationBarLocation.ToolTipText property is not specifically set, a tooltip is only displayed in the case where the location's text is not fully visible in the user interface, unless a listener of the event assigns a non-empty value to the Infragistics.Win.Misc.UltraWinNavigationBar.ToolTipDisplayingEventArgs.ToolTipText property of the event arguments. This makes it possible to either display a tooltip without handling the event (using the UltraNavigationBarLocation's ToolTipText property), or dynamically assign the text to be displayed in response to the event (using the ToolTipDisplayingEventArgs' ToolTipText property).
Note: When the UltraNavigationBarLocationSettings.TextButtonDisplayStyle property resolves to 'Hidden', the LocationToolTipDisplaying event fires when the cursor hovers over the LocationDropDownButtonUIElement. In this scenario, the Infragistics.Win.Misc.UltraWinNavigationBar.LocationToolTipDisplayingEventArgs.IsTextFullyVisible will return false, and the ToolTipText property of the event arguments will contain the value of the location's ToolTipText property (or the value of the DisplayText property when ToolTipText is not explicitly set), so that a tooltip is always displayed for the dropdown button when the text button is not visible.
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