RibbonControl.HyperlinkClick Event

Occurs when a hyperlink within the current RibbonControl is clicked.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Action")]
public event HyperlinkClickEventHandler HyperlinkClick

VB.NET

<DXCategory("Action")>
Public Event HyperlinkClick As HyperlinkClickEventHandler

Event Data

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

Property	Description
Link	Get or sets the URL of the clicked hyperlink.
MouseArgs	Gets or sets mouse coordinates calculated from the toolbar’s upper left corner.
Text	Gets or sets the hyperlink alt text. Note that modifying this text does not change the item caption.

Remarks

BarItems, displayed within a RibbonControl, can display hyperlinks within their BarItem.Captions and/or BarItem.Descriptions. Set the RibbonControl.AllowHtmlText property to true and format the desired string via the <href></href> tag. Refer to the HTML Text Formatting topic to learn more.

C#

public Form1() {
    InitializeComponent();
    ribbonControl1.AllowHtmlText = true;
    barStaticItem1.Caption = "Visit our <href=www.devexpress.com>Web-site</href>";
}

private void barStaticItem1_HyperlinkClick(object sender, DevExpress.Utils.HyperlinkClickEventArgs e) {
    System.Diagnostics.Process.Start(e.Link);
}

VB.NET

Public Sub Form1()
    InitializeComponent()
    ribbonControl1.AllowHtmlText = True
    barStaticItem1.Caption = "Visit our <href=www.devexpress.com>Web-site</href>"
End Sub

Private Sub barStaticItem1_HyperlinkClick(ByVal sender As Object, ByVal e As DevExpress.Utils.HyperlinkClickEventArgs)
    System.Diagnostics.Process.Start(e.Link)
End Sub

You can override the global RibbonControl.AllowHtmlText property setting for individual items. To do so, use the BarItem.AllowHtmlText property.