Class HyperlinkCollection

Namespace: Aspose.Cells
Assembly: Aspose.Cells.dll (25.2.0)

Encapsulates a collection of Aspose.Cells.Hyperlink objects.

public class HyperlinkCollection : CollectionBase<hyperlink>, IList<hyperlink>, ICollection<hyperlink>, IEnumerable<hyperlink>, ICollection, IEnumerable

Inheritance

object ← CollectionBase<hyperlink> ← HyperlinkCollection

Implements

IList<hyperlink>, ICollection<hyperlink>, IEnumerable<hyperlink>, ICollection, IEnumerable

Inherited Members

Examples

//Instantiating a Workbook object
Workbook workbook = new Workbook();

//Obtaining the reference of the newly added worksheet by passing its sheet index
Worksheet worksheet = workbook.Worksheets[0];

//Get Hyperlinks Collection
HyperlinkCollection hyperlinks = worksheet.Hyperlinks;

//Adding a hyperlink to a URL at "A1" cell
hyperlinks.Add("A1", 1, 1, "http://www.aspose.com");

//Saving the Excel file
workbook.Save("book1.xls");

'Instantiating a Workbook object
Dim workbook As Workbook = New Workbook()

'Obtaining the reference of the newly added worksheet by passing its sheet index
Dim worksheet As Worksheet = workbook.Worksheets(0)

'Get Hyperlinks Collection
Dim hyperlinks As HyperlinkCollection = worksheet.Hyperlinks

'Adding a hyperlink to a URL at "A1" cell
hyperlinks.Add("A1", 1, 1, "http://www.aspose.com")

'Saving the Excel file
workbook.Save("book1.xls")</code></pre>

## Properties

### <a id="Aspose_Cells_HyperlinkCollection_Item_System_Int32_"></a> this\[int\]

Gets the Aspose.Cells.Hyperlink element at the specified index.

```csharp
public Hyperlink this[int index] { get; }

Property Value

Hyperlink

Methods

Add(int, int, int, int, string)

Adds a hyperlink to a specified cell or a range of cells.

public int Add(int firstRow, int firstColumn, int totalRows, int totalColumns, string address)

Parameters

firstRow int

First row of the hyperlink range.

firstColumn int

First column of the hyperlink range.

totalRows int

Number of rows in this hyperlink range.

totalColumns int

Number of columns of this hyperlink range.

address string

Address of the hyperlink.

Returns

int

Aspose.Cells.Hyperlink object index.

Examples

[C#]
//Instantiating a Workbook object
Workbook excel = new Workbook();
Worksheet worksheet = excel.Worksheets[0];
worksheet.Hyperlinks.Add("A4", 1, 1, "http://www.aspose.com");
worksheet.Hyperlinks.Add("A5", 1, 1, "c:\\book1.xls");
```
```vb
'Instantiating a Workbook object
Dim excel As Workbook = New Workbook()
Dim worksheet as Worksheet = excel.Worksheets(0)
worksheet.Hyperlinks.Add("A4", 1, 1, "http://www.aspose.com")
worksheet.Hyperlinks.Add("A5", 1, 1, "c:\\book1.xls")
```

###  Add\(string, int, int, string\)

Adds a hyperlink to a specified cell or a range of cells.

```csharp
public int Add(string cellName, int totalRows, int totalColumns, string address)
```

#### Parameters

`cellName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Cell name.

`totalRows` [int](https://learn.microsoft.com/dotnet/api/system.int32)

Number of rows in this hyperlink range.

`totalColumns` [int](https://learn.microsoft.com/dotnet/api/system.int32)

Number of columns of this hyperlink range.

`address` [string](https://learn.microsoft.com/dotnet/api/system.string)

Address of the hyperlink.

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

Aspose.Cells.Hyperlink object index.

###  Add\(string, string, string, string, string\)

Adds a hyperlink to a specified cell or a range of cells.

```csharp
public int Add(string startCellName, string endCellName, string address, string textToDisplay, string screenTip)
```

#### Parameters

`startCellName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The top-left cell of the range.

`endCellName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The bottom-right cell of the range.

`address` [string](https://learn.microsoft.com/dotnet/api/system.string)

Address of the hyperlink.

`textToDisplay` [string](https://learn.microsoft.com/dotnet/api/system.string)

The text to be displayed for the specified hyperlink.

`screenTip` [string](https://learn.microsoft.com/dotnet/api/system.string)

The screenTip text for the specified hyperlink.

#### Returns

 [int](https://learn.microsoft.com/dotnet/api/system.int32)

Aspose.Cells.Hyperlink object index.

###  Clear\(\)

Clears all hyperlinks.

```csharp
public void Clear()
```

###  RemoveAt\(int\)

Remove the hyperlink  at the specified index in this collection.

```csharp
public void RemoveAt(int index)
```

#### Parameters

`index` [int](https://learn.microsoft.com/dotnet/api/system.int32)

The zero based index of the element.