LabelControl.HyperlinkClick Event

Occurs whenever an end-user clicks a hyperlink contained within the current LabelControl.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

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 DevExpress.Utils.HyperlinkClickEventArgs.

Remarks

You can add hyperlinks to your LabelControl along with a regular text string. To do so, set the LabelControl.AllowHtmlString property to true and format the required text with the <href></href> tag. To see the list of all available tags, refer to HTML Text Formatting.

When an end-user clicks the hyperlink, the HyperlinkClick event occurs. Handle it to perform specific operations, depending on the link.

Example

The following example shows how to format a LabelControl‘s text using HTML tags. HTML formatting is enabled via the LabelControl.AllowHtmlString property. To respond to an end-user clicking the hyperlink, the LabelControl.HyperlinkClick event is handled. The image below shows the result:

C#

labelControl1.Text = "<size=14>Size = 14<br>" +
                     "<b>Bold</b> <i>Italic</i> <u>Underline</u><br>" + 
                     "<size=11>Size = 11<br>" + 
                     "<color=255, 0, 0>Sample Text</color></size>" +
                     "<href=www.devexpress.com>Hyperlink</href>";
labelControl1.AllowHtmlString = true;
labelControl1.Appearance.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap;
labelControl1.Appearance.Options.UseTextOptions = true;
labelControl1.AutoSizeMode = DevExpress.XtraEditors.LabelAutoSizeMode.Vertical;

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

VB.NET

labelControl1.Text = "<size=14>Size = 14<br>" + _
                     "<b>Bold</b> <i>Italic</i> <u>Underline</u><br>" +  _
                     "<size=11>Size = 11<br>" + _
                     "<color=255, 0, 0>Sample Text</color></size><br>" + _
                     "<href=www.devexpress.com>Hyperlink</href>"
labelControl1.AllowHtmlString = True
labelControl1.Appearance.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap
labelControl1.Appearance.Options.UseTextOptions = True
labelControl1.AutoSizeMode = DevExpress.XtraEditors.LabelAutoSizeMode.Vertical

Private Sub LabelControl1_HyperlinkClick(sender As Object, e As DevExpress.Utils.HyperlinkClickEventArgs) Handles LabelControl1.HyperlinkClick
    System.Diagnostics.Process.Start(e.Link)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the HyperlinkClick 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-implement-the-insert-document-field-dialog-winforms-version-t223036/CS/WindowsFormsApplication1/InsertFieldModules/ucPAGENUMBER.cs#L18

    labelControl1.Text += "<href=https://www.devexpress.com/Support/Center/Question/Details/T221870>https://www.devexpress.com/Support/Center/Question/Details/T221870</href>";
    labelControl1.HyperlinkClick += labelControl1_HyperlinkClick;
}

VB.NET

how-to-implement-the-insert-document-field-dialog-winforms-version-t223036/VB/WindowsFormsApplication1/InsertFieldModules/ucPAGENUMBER.vb#L21

    labelControl1.Text &= "<href=https://www.devexpress.com/Support/Center/Question/Details/T221870>https://www.devexpress.com/Support/Center/Question/Details/T221870</href>"
    AddHandler labelControl1.HyperlinkClick, AddressOf labelControl1_HyperlinkClick
Else