HyperlinkCollection.Add(CellRange, String, Boolean, String) Method
Adds a hyperlink into the specified cell or cell range and returns the newly created object.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v24.2.Core.dll
NuGet Package: DevExpress.Spreadsheet.Core
Declaration
Parameters
| Name | Type | Description |
|---|---|---|
| range | CellRange | A CellRange object that specifies a cell or cell range where a hyperlink is inserted. This value is assigned to the Hyperlink.Range property. |
| uri | String | A String value that specifies a web page, existing file, e-mail address or cell range in the current workbook to which a hyperlink refers. This value is assigned to the HyperlinkBase.Uri property. |
| isExternal | Boolean | A Boolean value that specifies whether a hyperlink refers to an external resource (true) or to a cell range within the current workbook (false). This value is assigned to the HyperlinkBase.IsExternal property. |
| displayText | String | A String value that specifies text to be displayed for a hyperlink. This value is assigned to the Hyperlink.DisplayText property and specifies the top left cell value of the range into which a hyperlink is added. |
Returns
| Type | Description |
|---|---|
| Hyperlink | A Hyperlink object that specifies the created hyperlink. |
Remarks
The Add method appends a Hyperlink object to the end of the collection.
Example
This example demonstrates how to create a hyperlink to a web page or cell range in a workbook. To do this, use the HyperlinkCollection.Add method with the cell or cell range into which a hyperlink should be inserted, the target web page, or the workbook location passed along with other parameters.
Important
The maximum number of hyperlinks in a worksheet is 65,530.
All hyperlinks created in a worksheet are contained in the HyperlinkCollection collection returned by the Worksheet.Hyperlinks property. To adjust an existing hyperlink, use properties of the Hyperlink object, which can be accessed by the hyperlink index from the HyperlinkCollection collection. To get all hyperlinks contained in the specified cell range, use the HyperlinkCollection.GetHyperlinks method.
To remove hyperlinks, use the HyperlinkCollection.Remove, HyperlinkCollection.RemoveAt or HyperlinkCollection.Clear method. The Worksheet.ClearHyperlinks method deletes all hyperlinks from the specified range of cells.
// Create a hyperlink to a web page.
Cell cell = worksheet.Cells["A1"];
worksheet.Hyperlinks.Add(cell, "https://www.devexpress.com/", true, "DevExpress");
// Create a hyperlink to a cell range in a workbook.
CellRange range = worksheet.Range["C3:D4"];
Hyperlink cellHyperlink = worksheet.Hyperlinks.Add(range, "Sheet2!B2:E7", false, "Select Range");
cellHyperlink.TooltipText = "Click Me";
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(CellRange, String, Boolean, String) 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.