XlHyperlink.Reference Property

Gets or sets the cell or cell range that contains the hyperlink.

Namespace: DevExpress.Export.Xl

Assembly: DevExpress.Printing.v19.1.Core.dll

Declaration

C#

public XlCellRange Reference { get; set; }

VB.NET

Public Property Reference As XlCellRange

Property Value

Type	Description
XlCellRange	An XlCellRange object specifying the location of a hyperlink in a worksheet.

Remarks

Use the Reference property to specify the cell or cell range to which the hyperlink should be attached. When an end-user clicks any cell in this range, the hyperlink navigates to the address specified by the XlHyperlinkBase.TargetUri property.

For an example on how to create a hyperlink to a web page or range in a workbook, 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/xl-export-api-examples-t253492

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 = "#Sheet1!C5";
            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 = "http://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 = "#Sheet1!C5"
            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 = "http://www.devexpress.com"
            sheet.Hyperlinks.Add(hyperlink)
        End Using
    End Using
End Using