LayoutControl.HyperlinkClick Event

Occurs each time a user clicks hyperlinks within captions of layout items and layout groups.

Assembly : DevExpress.XtraLayout.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

[DXCategory("Action")]
public event EventHandler<LayoutItemHyperlinkClickEventArgs> HyperlinkClick

<DXCategory("Action")>
Public Event HyperlinkClick As EventHandler(Of LayoutItemHyperlinkClickEventArgs)

Event Data

The HyperlinkClick event's data class is DevExpress.XtraLayout.LayoutItemHyperlinkClickEventArgs.

Remarks

If you add a hyperlink to the text of a layout item or layout group, you can then handle the HyperlinkClick event to perform actions when a user clicks this hyperlink.

You can add a hyperlink to a layout item’s caption as follows:

Set the LayoutControlItem.AllowHtmlStringInCaption property to true to enable HTML-inspired Text Formatting.
Add a hyperlink to the item’s caption (LayoutControlItem.Text) using the <href></href> tag.

To add a hyperlink to a layout group’s caption, do the following:

Set the LayoutGroup.AllowHtmlStringInCaption property to true to enable HTML-inspired Text Formatting
Add a hyperlink to the group’s caption (LayoutControlGroup.Text) using the <href></href> tag.

Note

The HyperlinkClick event does not fire when a user clicks hyperlinks displayed within a tabbed group’s tabs.

Example

The following example adds a hyperlink to a layout item’s caption and launches this link when a user clicks it.

C#
VB.NET

csharp

layoutControlItem1.AllowHtmlStringInCaption = true;
layoutControlItem1.Text = "Leave feedback <href=www.devexpress.com>(learn more)</href>";
//...
private void layoutControl1_HyperlinkClick(object sender, DevExpress.XtraLayout.LayoutItemHyperlinkClickEventArgs e) {
    System.Diagnostics.Process.Start(e.Link);
}

LayoutControlItem1.AllowHtmlStringInCaption = True
LayoutControlItem1.Text = "Leave feedback <href=www.devexpress.com>(learn more)</href>"
'...
Private Sub LayoutControl1_HyperlinkClick(sender As Object, e As DevExpress.XtraLayout.LayoutItemHyperlinkClickEventArgs) Handles LayoutControl1.HyperlinkClick
    System.Diagnostics.Process.Start(e.Link)
End Sub