PivotGridControl.FieldTooltipShowing Event

Occurs before a tooltip is invoked.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public event PivotFieldTooltipShowingEventHandler FieldTooltipShowing
Public Event FieldTooltipShowing As PivotFieldTooltipShowingEventHandler

Event Data

The FieldTooltipShowing event's data class is PivotFieldTooltipShowingEventArgs. The following properties provide information specific to this event:

Property Description
HitInfo Gets information about the point where the tooltip should be invoked.
Point Gets the coordinates of the point where the tooltip should be invoked.
ShowTooltip Gets or sets whether to show the tooltip.
Text Gets or sets the tooltip text.

Remarks

The FieldTooltipShowing event occurs when a tooltip is about to be invoked, e.g. when an end-user hovers with the mouse over a trimmed caption. This event allows you to cancel invoking the tooltip, or specify custom text to be displayed within.

You can obtain the coordinates of the point where the tooltip is to be invoked via the event parameter's PivotFieldTooltipShowingEventArgs.Point property. Use the PivotFieldTooltipShowingEventArgs.HitInfo property to obtain more information about this point (e.g. which visual element is located there).

To specify custom text for the tooltip, use the PivotFieldTooltipShowingEventArgs.Text property. Initially, this property contains the default tooltip string. Use the event parameter's PivotFieldTooltipShowingEventArgs.ShowTooltip property, to specify whether to invoke the tooltip.

See Also