XlHyperlinkBase.TargetUri Property

Gets or sets the hyperlink destination.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v24.2.Core.dll

Declaration

C#

public string TargetUri { get; set; }

VB.NET

Public Property TargetUri As String

Property Value

Type	Description
String	A String value that specifies the destination to which a hyperlink refers.

Remarks

When an end-user clicks a cell range or picture, the associated hyperlink navigates to the location returned by the TargetUri property.

You can set the TargetUri property to one of the following values depending on the location to which your hyperlink should refer.

Hyperlink Destination	TargetUri Value	Example
Place in the current workbook	A cell reference or defined name preceded by the worksheet name.	“#Sheet1!B4”
Place in an external workbook	A cell reference or defined name preceded by the path to a file, the workbook and worksheet names. If a path to the destination workbook is not specified, the path relative to the location of the current workbook will be used.	“D:\Shared\Expenses.xlsx#Sheet1!C5” “Document.xls#Sheet1!B4”
Web page	A web address.	“https://www.devexpress.com/“
E-mail address	An e-mail address preceded by the “mailto:” prefix.	mailto:[e-mail]
Existing File or Directory	A path to a file and file name, or a path to a directory. A path can be absolute or relative to the directory where the current workbook is located.	“D:\Pictures\Image1.png” “..\..\..\MyBook.xlsx”

For details, on how to create a hyperlink, refer to the How to: Add a Hyperlink to a Cell example.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/excel-export-api-examples

MiscellaneousActions.cs

// Create a worksheet.
using (IXlSheet sheet = document.CreateSheet()) {
    using(IXlColumn column = sheet.CreateColumn()) {
        column.WidthInPixels = 300;
    }

    // Create a hyperlink to a cell in the current workbook.
    using (IXlRow row = sheet.CreateRow()) {
        using(IXlCell cell = row.CreateCell()) {
            cell.Value = "Local link";
            cell.Formatting = XlCellFormatting.Hyperlink;
            XlHyperlink hyperlink = new XlHyperlink();
            hyperlink.Reference = new XlCellRange(new XlCellPosition(cell.ColumnIndex, cell.RowIndex));
            hyperlink.TargetUri = $"#'{targetSheet}'!{targetPosition.ToString()}";
            sheet.Hyperlinks.Add(hyperlink);
        }
    }

    // Create a hyperlink to a cell located in the external workbook.
    using (IXlRow row = sheet.CreateRow()) {
        using(IXlCell cell = row.CreateCell()) {
            cell.Value = "External file link";
            cell.Formatting = XlCellFormatting.Hyperlink;
            XlHyperlink hyperlink = new XlHyperlink();
            hyperlink.Reference = new XlCellRange(new XlCellPosition(cell.ColumnIndex, cell.RowIndex));
            hyperlink.TargetUri = "linked.xlsx#Sheet1!C5";
            sheet.Hyperlinks.Add(hyperlink);
        }
    }

    // Create a hyperlink to a web page.
    using (IXlRow row = sheet.CreateRow()) {
        using(IXlCell cell = row.CreateCell()) {
            cell.Value = "External URI";
            cell.Formatting = XlCellFormatting.Hyperlink;
            XlHyperlink hyperlink = new XlHyperlink();
            hyperlink.Reference = new XlCellRange(new XlCellPosition(cell.ColumnIndex, cell.RowIndex));
            hyperlink.TargetUri = "https://www.devexpress.com/";
            sheet.Hyperlinks.Add(hyperlink);
        }
    }
}

MiscellaneousActions.vb

' Create a worksheet.
Using sheet As IXlSheet = document.CreateSheet()
    Using column As IXlColumn = sheet.CreateColumn()
        column.WidthInPixels = 300
    End Using

    ' Create a hyperlink to a cell in the current workbook.
    Using row As IXlRow = sheet.CreateRow()
        Using cell As IXlCell = row.CreateCell()
            cell.Value = "Local link"
            cell.Formatting = XlCellFormatting.Hyperlink
            Dim hyperlink As New XlHyperlink()
            hyperlink.Reference = New XlCellRange(New XlCellPosition(cell.ColumnIndex, cell.RowIndex))
            hyperlink.TargetUri = $"#'{targetSheet}'!{targetPosition.ToString()}"
            sheet.Hyperlinks.Add(hyperlink)
        End Using
    End Using

    ' Create a hyperlink to a cell located in the external workbook.
    Using row As IXlRow = sheet.CreateRow()
        Using cell As IXlCell = row.CreateCell()
            cell.Value = "External file link"
            cell.Formatting = XlCellFormatting.Hyperlink
            Dim hyperlink As New XlHyperlink()
            hyperlink.Reference = New XlCellRange(New XlCellPosition(cell.ColumnIndex, cell.RowIndex))
            hyperlink.TargetUri = "linked.xlsx#Sheet1!C5"
            sheet.Hyperlinks.Add(hyperlink)
        End Using
    End Using

    ' Create a hyperlink to a web page.
    Using row As IXlRow = sheet.CreateRow()
        Using cell As IXlCell = row.CreateCell()
            cell.Value = "External URI"
            cell.Formatting = XlCellFormatting.Hyperlink
            Dim hyperlink As New XlHyperlink()
            hyperlink.Reference = New XlCellRange(New XlCellPosition(cell.ColumnIndex, cell.RowIndex))
            hyperlink.TargetUri = "https://www.devexpress.com/"
            sheet.Hyperlinks.Add(hyperlink)
        End Using
    End Using
End Using

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the TargetUri 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#

excel-export-api-examples/CS/XLExportExamples/SpreadsheetActions/PictureActions.cs#L142

picture.SetImage(Image.FromFile(Path.Combine(imagesPath, "DevExpress.png")), ImageFormat.Png);
picture.HyperlinkClick.TargetUri = "http://www.devexpress.com";
picture.HyperlinkClick.Tooltip = "Developer Express Inc.";

VB.NET

excel-export-api-examples/VB/XLExportExamples/SpreadsheetActions/PictureActions.vb#L122

picture.Image = Image.FromFile(Path.Combine(imagesPath, "DevExpress.png"))
picture.HyperlinkClick.TargetUri = "http://www.devexpress.com"
picture.HyperlinkClick.Tooltip = "Developer Express Inc."