SpreadsheetHyperlinkCollection Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Collection of hyperlinks (SpreadsheetHyperlink).

public sealed class SpreadsheetHyperlinkCollection : IEnumerable<SpreadsheetHyperlink>, IEnumerable
Public NotInheritable Class SpreadsheetHyperlinkCollection
    Implements IEnumerable(Of SpreadsheetHyperlink), IEnumerable
Inheritance:
System.Object
SpreadsheetHyperlinkCollection
Implements
System.Collections.Generic.IEnumerable<SpreadsheetHyperlink>
System.Collections.IEnumerable
Remarks

You can set cell style to underline and font color to blue in order to appear as hyperlink, that is not done automatically.

Properties

Count

Gets the number of hyperlinks contained in the collection.

public int Count { get; }
Public ReadOnly Property Count As Integer
Property Value
System.Int32

Item[Int32]

Gets the hyperlink at the specified index.

public SpreadsheetHyperlink this[int index] { get; }
Public ReadOnly Property Item(index As Integer) As SpreadsheetHyperlink
Parameters
index
System.Int32

The zero-based index of the hyperlink.

Property Value
SpreadsheetHyperlink

The hyperlink at the specified index.

Exceptions
System.ArgumentOutOfRangeException

Argument index is out of range.

Methods

Clear()

Removes all hyperlinks.

public void Clear()
Public Sub Clear

GetEnumerator()

Returns an enumerator for the collection.

public IEnumerator<SpreadsheetHyperlink> GetEnumerator()
Public Function GetEnumerator As IEnumerator(Of SpreadsheetHyperlink)
Returns
System.Collections.Generic.IEnumerator<SpreadsheetHyperlink>

An enumerator for the collection.

Remove(SpreadsheetHyperlink)

Removes the first occurrence of a specific SpreadsheetHyperlink from the collection.

public bool Remove(SpreadsheetHyperlink item)
Public Function Remove(item As SpreadsheetHyperlink) As Boolean
Parameters
item
SpreadsheetHyperlink

The SpreadsheetHyperlink to remove from the collection.

Returns
System.Boolean

true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the original collection.

RemoveAt(Int32)

Removes the hyperlink at the specified index.

public void RemoveAt(int index)
Public Sub RemoveAt(index As Integer)
Parameters
index
System.Int32

The zero-based index of the hyperlink to remove.

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable