NavBarControl.GetHint Event

Allows hints to be customized dynamically.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v20.1.dll

Declaration

public event NavBarGetHintEventHandler GetHint
Public Event GetHint As NavBarGetHintEventHandler

Event Data

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

Property Description
Appearance Gets the appearance settings used to paint the hint.
Group Gets the group for which the hint is displayed. Inherited from NavBarCustomHintEventArgs.
Hint Gets or sets the hint text.
HintInfo Gets an object providing information on the NavBarControl's element for which the hint event was fired. Inherited from NavBarCustomHintEventArgs.
Link Gets the link for which the hint is displayed. Inherited from NavBarCustomHintEventArgs.

Remarks

Hints are supported for groups and links if the NavBarControl.ShowGroupHint and NavBarControl.ShowLinkHint properties are enabled. You can specify hints for groups and links via their NavElement.Hint properties. The GetHint event allows you to customize hint text dynamically, according to your needs. Event parameters allow you to determine the group or link on which the hint is about to be displayed. You can change the hint text for the currently processed element.

When the VSToolBoxView paint style is applied, hints for links are not displayed. In this paint style, only hints for groups can be supplied.

If the NavBarControl is painted using the VSToolBoxView style, the hint appearance can be customized via the event's Appearance parameter. To change hint appearance in other paint styles, add a DefaultToolTipController component onto the form, handle its ToolTipController.BeforeShow event and customize the event's Appearance parameter.

See Also