BarManager.HighlightedLinkChanged Event

Fires immediately after the highlighted link has been changed.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v19.1.dll

Declaration

C#

[DXCategory("Events")]
public event HighlightedLinkChangedEventHandler HighlightedLinkChanged

VB.NET

<DXCategory("Events")>
Public Event HighlightedLinkChanged As HighlightedLinkChangedEventHandler

Event Data

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

Property	Description
Link	Gets the currently highlighted link.
PrevLink	Gets the previously highlighted link.

Remarks

Write a HighlightedLinkChanged event handler to perform specific actions each time the currently highlighted link is changed. The event parameter allows you to determine the previous and currently highlighted link. Note that this event fires when none of links was previously highlighted or when none of them becomes highlighted. The properties representing the currently and previously highlighted links can return null references in such cases.

If you want to determine the currently highlighted link directly from your code, use the BarManager.HighlightedLink property.

Example

The following example shows how to paint hot-tracked bar items using a bold font.

This example contains two separate pieces of code. The first assigns a bold font to the links within the browser bar. This is performed by modifying the BarItem.Appearance property of the associated items. The AppearanceOptions.UseFont option is disabled to prevent bar items from being immediately painted using the assigned font.

C#

using DevExpress.XtraBars; 

barManager1.ForceInitialize();
Font itemFont = new Font(barManager1.GetController().AppearancesBar.ItemsFont, FontStyle.Bold);
foreach (BarItemLink link in barBrowser.ItemLinks) {
   link.Item.Appearance.Font = itemFont;
   link.Item.Appearance.Options.UseFont = false;
}

VB.NET

Imports DevExpress.XtraBars

BarManager1.ForceInitialize()
Dim ItemFont As New Font(barManager1.GetController().AppearancesBar.ItemsFont, FontStyle.Bold)
Dim Link As BarItemLink
For Each Link In BarBrowser.ItemLinks
   Link.Item.Appearance.Font = ItemFont
   Link.Item.Appearance.Options.UseFont = False
Next

The next code sample handles the BarManager.HighlightedLinkChanged event. It is used to enable the bold font for hot-tracked items.

The image below display the result of handling the BarManager.HighlightedLinkChanged event. The hot-tracked link is painted using the bold font.

C#

private void barManager1_HighlightedLinkChanged(object sender, 
  DevExpress.XtraBars.HighlightedLinkChangedEventArgs e) {
    if (e.PrevLink != null && e.PrevLink.Bar == barBrowser)
      e.PrevLink.Item.Appearance.Options.UseFont = false;
    if (e.Link != null && e.Link.Bar == barBrowser) 
      e.Link.Item.Appearance.Options.UseFont = true;
}

VB.NET

Private Sub BarManager1_HighlightedLinkChanged(ByVal sender As Object, _
 ByVal e As DevExpress.XtraBars.HighlightedLinkChangedEventArgs) _
 Handles BarManager1.HighlightedLinkChanged
   If (Not e.PrevLink Is Nothing) Then
      If (e.PrevLink.Bar Is BarBrowser) Then _
         e.PrevLink.Item.Appearance.Options.UseFont = False
   End If
   If (Not e.Link Is Nothing) Then
      If (e.Link.Bar Is BarBrowser) Then _
         e.Link.Item.Appearance.Options.UseFont = True
   End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the HighlightedLinkChanged event.

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-expand-a-menu-when-the-mouse-cursor-is-hovering-over-the-menu-item-e2120/CS/Q253018/BarHelper.cs#L26

{
    manager.HighlightedLinkChanged -= OnBarManagerHighlightedLinkChanged;
    if (value)

how-to-show-tooltips-for-menu-items-e3133/CS/WindowsApplication1/ToolTipHelper.cs#L27

{
    manager.HighlightedLinkChanged -= OnHighlightedLinkChanged;
    if (value)

links-searching-functionality-in-the-popupmenu-applicationmenu-dropdown-e4364/CS/WindowsFormsApplication1/PopupMenuSearchHelper.cs#L43

    someMenu.Manager.HighlightedLinkChanged += new HighlightedLinkChangedEventHandler(Manager_HighlightedLinkChanged);
}

VB.NET

how-to-expand-a-menu-when-the-mouse-cursor-is-hovering-over-the-menu-item-e2120/VB/Q253018/BarHelper.vb#L22

Set(ByVal value As Boolean)
    RemoveHandler manager.HighlightedLinkChanged, AddressOf OnBarManagerHighlightedLinkChanged
    If value Then

how-to-show-tooltips-for-menu-items-e3133/VB/WindowsApplication1/ToolTipHelper.vb#L23

Set(ByVal value As Boolean)
    RemoveHandler manager.HighlightedLinkChanged, AddressOf OnHighlightedLinkChanged
    If value Then

links-searching-functionality-in-the-popupmenu-applicationmenu-dropdown-e4364/VB/WindowsFormsApplication1/PopupMenuSearchHelper.vb#L42

    AddHandler someMenu.Manager.HighlightedLinkChanged, AddressOf Manager_HighlightedLinkChanged
End Sub