HyperlinkBase.IsExternal Property
Gets a value that indicates whether the hyperlink refers to an external resource (web page, e-mail address, file or directory) or to a cell range within the current workbook.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v19.1.Core.dll
Declaration
Property Value
| Type | Description |
|---|---|
| Boolean | true, if the hyperlink refers to an external resource; otherwise, false. |
Remarks
When associating a hyperlink with a cell range or picture, you call either the HyperlinkCollection.Add or Shape.InsertHyperlink method respectively, and pass the hyperlink destination (HyperlinkBase.Uri) and a parameter that indicates whether the hyperlink refers to an external resource or to a location within the current workbook. This parameter value is assigned to the IsExternal property.
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.
Note
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.
Range range = worksheet.Range["C3:D4"];
Hyperlink cellHyperlink = worksheet.Hyperlinks.Add(range, "Sheet2!B2:E7", false, "Select Range");
cellHyperlink.TooltipText = "Click Me";