How to: Add a Hyperlink to a Cell
- 2 minutes to read
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.
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.
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-e4655
// Create a hyperlink to a web page. Cell cell = worksheet.Cells["A1"]; worksheet.Hyperlinks.Add(cell, "http://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";
The SpreadsheetControl.HyperlinkClick event is fired when an end-user activates a hyperlink in a document loaded in the SpreadsheetControl. This event occurs when an end-user clicks the hyperlink, or clicks the hyperlink with the ALT key pressed, or right-clicks the hyperlink to invoke the context menu and selects the Open Hyperlink command.