Xceed Workbooks for .NET v1.4 Documentation
Add(String,Int32,Int32,Int32,Int32,String,String) Method


Xceed.Workbooks.NET Assembly > Xceed.Workbooks.NET Namespace > HyperlinkCollection Class > Add Method : Add(String,Int32,Int32,Int32,Int32,String,String) Method
The address that corresponds to the Hyperlink's destination. This can be the Address of a Cell, an external document, a website or an email address.
The Id of the Row where the Hyperlink's location starts.
The Id of the Column where the Hyperlink's location starts.
Specifies on how many vertical Cells the Hyperlink is active. The default value is 1.
Specifies on how many horizontal Cells the Hyperlink is active. The default value is 1.
The Cell’s text, if it is different from the existing one. The default value is null.
The tooltip text that will be displayed on mouse over.
Adds a new Hyperlink based on a Row and a Column Id.
Syntax
'Declaration

 

Public Overloads Function Add( _

   ByVal destinationAddress As String, _

   ByVal topLeftRowId As Integer, _

   ByVal topLeftColumnId As Integer, _

   Optional ByVal hyperlinkRowLength As Integer, _

   Optional ByVal hyperlinkColumnLength As Integer, _

   Optional ByVal textToDisplay As String, _

   Optional ByVal tooltip As String _

) As Hyperlink
'Usage

 

Dim instance As HyperlinkCollection

Dim destinationAddress As String

Dim topLeftRowId As Integer

Dim topLeftColumnId As Integer

Dim hyperlinkRowLength As Integer

Dim hyperlinkColumnLength As Integer

Dim textToDisplay As String

Dim tooltip As String

Dim value As Hyperlink

 

value = instance.Add(destinationAddress, topLeftRowId, topLeftColumnId, hyperlinkRowLength, hyperlinkColumnLength, textToDisplay, tooltip)

Parameters

destinationAddress
The address that corresponds to the Hyperlink's destination. This can be the Address of a Cell, an external document, a website or an email address.
topLeftRowId
The Id of the Row where the Hyperlink's location starts.
topLeftColumnId
The Id of the Column where the Hyperlink's location starts.
hyperlinkRowLength
Specifies on how many vertical Cells the Hyperlink is active. The default value is 1.
hyperlinkColumnLength
Specifies on how many horizontal Cells the Hyperlink is active. The default value is 1.
textToDisplay
The Cell’s text, if it is different from the existing one. The default value is null.
tooltip
The tooltip text that will be displayed on mouse over.
Requirements

Target Platforms: Windows 11, Windows 10, 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

See Also

Reference

HyperlinkCollection Class
HyperlinkCollection Members
Overload List