WorksheetHyperlink Constructor(WorksheetRegion,Object,String,String)

Creates a new WorksheetHyperlink instance.

Syntax

Visual Basic

'Declaration
 
Public Function New( _
   ByVal sourceRegion As WorksheetRegion, _
   ByVal target As Object, _
   Optional ByVal displayText As String, _
   Optional ByVal toolTip As String _
)

C#

public WorksheetHyperlink( 
   WorksheetRegion sourceRegion,
   object target,
   string displayText,
   string toolTip
)

Parameters

sourceRegion

The region on which the hyperlink should reside.

target

The target of the hyperlink, which can be a string, WorksheetCell, WorksheetRegion, or NamedReference instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:[e-mail]" or "mailto:[e-mail]?subject=Email%20Subject".

displayText

The text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text.

toolTip

The text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip.

Exceptions

Exception	Description
System.ArgumentNullException	Occurs when sourceRegion is null.
System.ArgumentException	Occurs when target is not a string, WorksheetCell, WorksheetRegion, or NamedReference instance.
System.ArgumentException	Occurs when target is a string longer than 256 characters.
System.ArgumentException	Occurs when target is a cell, region, or named reference which is not from the same workbook as sourceRegion.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2