XRControl.NavigateUrl Property

Bindable. Specifies the URL to navigate to when the control is clicked.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

[SRCategory(ReportStringId.CatNavigation)]
[DefaultValue("")]
public virtual string NavigateUrl { get; set; }

VB.NET

<SRCategory(ReportStringId.CatNavigation)>
<DefaultValue("")>
Public Overridable Property NavigateUrl As String

Property Value

Type	Default	Description
String	String.Empty	A String value containing the URL.

Remarks

Note

The NavigateUrl property is bindable, which means that it can be bound to a data field in a report’s data source. To learn more, see the Binding Report Controls to Data section.

Use the NavigateUrl property to specify an URL which the client web browser navigates to whenever the XRControl is clicked. If the NavigateUrl property is assigned, the XRControl serves as a link. If the property is set to an empty string (String.Empty) no navigation is performed when the control is clicked. The Web browser displays a Web page in the window or frame as specified by the XRControl.Target property.

To make the hyperlink work properly, start the URL with the “http://“ or “https://“ prefix.

Important

Users of the End-User Report Designer for the Web can add a “javascript:” prefix to the NavigateUrl property value, which allows the link to execute JavaScript code on the client, making other users vulnerable to cross-site scripting (XSS) attacks.

By default, JavaScript code execution is prohibited by the ASPxDocumentViewer and ASPxWebDocumentViewer controls. If your application relies on scripts in URLs, you can explicitly enable them using the following properties.

• ASPxWebDocumentViewer.AllowURLsWithJSContent
• WebDocumentViewerSettings.AllowURLsWithJSContent
• HtmlExportOptionsBase.AllowURLsWithJSContent

Not all descendants of the XRControl class use the NavigateUrl property. For example, the Band class descendants ignore this setting.

Example

This example demonstrates how to create a hyperlink in a report. Note that such label behaves as a hyperlink both in a report’s Print Preview and HTML, PDF, RTF, XLS and XLSX formats.

To add a hyperlink, to the Report Detail Band, handle the Report’s XRControl.BeforePrint event in the following way.

C#

using DevExpress.XtraReports.UI;
// ...

private void XtraReport1_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    // Create a new hyperlink and add it to the report's Detail Band.
    Bands.GetBandByType(typeof(DetailBand)).Controls.Add(CreateHyperlink());
}

VB.NET

Imports DevExpress.XtraReports.UI
' ...

Private Sub XtraReport1_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs)
    Create a new hyperlink and add it to the report's Detail Band.
    Bands.GetBandByType(GetType(DetailBand)).Controls.Add(CreateHyperlink())
End Sub

The code below creates a hyperlink using the XRLabel object, and specifies its XRControl.NavigateUrl, XRControl.Target and other properties.

C#

using System.Drawing;
using DevExpress.XtraReports.UI;
// ...

public XRLabel CreateHyperlink(){
    // Create a label for a hyperlink.
    XRLabel hyperlinkLabel = new XRLabel();

    // Set its main properties.
    hyperlinkLabel.Text = "DevExpress Inc.";
    hyperlinkLabel.Width = 200;
    hyperlinkLabel.ForeColor = Color.Blue;
    hyperlinkLabel.Font = new Font("Tahoma", 12, FontStyle.Underline);

    // Set its URL and target.
    hyperlinkLabel.NavigateUrl = "http://www.devexpress.com";
    hyperlinkLabel.Target = "_blank";

    return hyperlinkLabel;
}

VB.NET

Imports System.Drawing
Imports DevExpress.XtraReports.UI
' ...

Public Function CreateHyperlink() As XRLabel
    ' Create a label for a hyperlink.
    Dim hyperlinkLabel As XRLabel = New XRLabel()

    ' Set its main properties.
    hyperlinkLabel.Text = "DevExpress Inc."
    hyperlinkLabel.Width = 200
    hyperlinkLabel.ForeColor = Color.Blue
    hyperlinkLabel.Font = New Font("Tahoma", 12, FontStyle.Underline)

    ' Set its URL and target.
    hyperlinkLabel.NavigateUrl = "http://www.devexpress.com"
    hyperlinkLabel.Target = "_blank"

    Return hyperlinkLabel
End Function

Related GitHub Examples

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

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#

Reporting_how-to-insert-a-dynamic-hyperlink-in-a-web-report-e484/CS/HyperlinkInReport/XtraReport1.cs#L17

private void xrLabel3_BeforePrint(object sender, System.Drawing.Printing.PrintEventArgs e) {
    ((XRLabel)sender).NavigateUrl = string.Format("MoreInfo.aspx?ID={0}", this.GetCurrentColumnValue("ID"));
}

Reporting_how-to-create-a-custom-hyperlink-control-e447/CS/XtraReport1.cs#L14

DXHtmlAnchor link = new DXHtmlAnchor();
link.HRef = ((XRLabel)sender).NavigateUrl;
link.InnerText = e.Brick.Text;

VB.NET

Reporting_how-to-insert-a-dynamic-hyperlink-in-a-web-report-e484/VB/HyperlinkInReport/XtraReport1.vb#L20

Private Sub xrLabel3_BeforePrint(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintEventArgs) Handles xrLabel3.BeforePrint
    CType(sender, XRLabel).NavigateUrl = String.Format("MoreInfo.aspx?ID={0}", Me.GetCurrentColumnValue("ID"))
End Sub

Reporting_how-to-create-a-custom-hyperlink-control-e447/VB/XtraReport1.vb#L17

Dim link As New DXHtmlAnchor()
link.HRef = (CType(sender, XRLabel)).NavigateUrl
link.InnerText = e.Brick.Text