Back to Devexpress

HyperlinkCollection.GetHyperlinks(CellRange) Method

officefileapi-devexpress-dot-spreadsheet-dot-hyperlinkcollection-dot-gethyperlinks-x28-devexpress-dot-spreadsheet-dot-cellrange-x29.md

latest3.0 KB
Original Source

HyperlinkCollection.GetHyperlinks(CellRange) Method

Gets hyperlink(s) contained in the specified cell range.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
IList<Hyperlink> GetHyperlinks(
    CellRange range
)
vb
Function GetHyperlinks(
    range As CellRange
) As IList(Of Hyperlink)

Parameters

NameTypeDescription
rangeCellRange

A CellRange object specifying a cell range that contains hyperlinks to be returned.

|

Returns

TypeDescription
IList<Hyperlink>

A collection of hyperlinks within the specified range of cells.

|

Remarks

The GetHyperlinks method returns all hyperlinks contained in cell ranges that intersect the specified cell range. To check whether a hyperlink is contained in the worksheet, use the HyperlinkCollection.Contains method.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetHyperlinks(CellRange) method.

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.

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/CellActions.vb#L228

vb
worksheet.ClearHyperlinks(worksheet("C5"))
Dim hyperlinkD5 As Hyperlink = worksheet.Hyperlinks.GetHyperlinks(worksheet("D5"))(0)
worksheet.Hyperlinks.Remove(hyperlinkD5)

See Also

How to: Add a Hyperlink to a Cell

HyperlinkCollection Interface

HyperlinkCollection Members

DevExpress.Spreadsheet Namespace