Documentation

Class HyperlinkCollection

Represents a collection of hyperlinks.

Inheritance
System.Object
CellRangeInsertedOrRemovedAwareCollectionBase
CellRangeInsertedOrRemovedAwareCollection<SpreadsheetHyperlink>
HyperlinkCollection
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class HyperlinkCollection : CellRangeInsertedOrRemovedAwareCollection<SpreadsheetHyperlink>, IEnumerable<SpreadsheetHyperlink>, IEnumerable

Constructors

HyperlinkCollection(Worksheet)

Initializes a new instance of the HyperlinkCollection class.

Declaration
public HyperlinkCollection(Worksheet worksheet)
Parameters
Worksheet worksheet

The worksheet.

Methods

Add(CellIndex, HyperlinkInfo)

Adds a new hyperlink to the collection.

Declaration
public SpreadsheetHyperlink Add(CellIndex cellIndex, HyperlinkInfo hyperlinkInfo)
Parameters
CellIndex cellIndex

Index of the cell.
HyperlinkInfo hyperlinkInfo

The hyperlink info.
Returns
SpreadsheetHyperlink

The new hyperlink.

Add(CellRange, HyperlinkInfo)

Adds a new hyperlink to the collection.

Declaration
public SpreadsheetHyperlink Add(CellRange cellRange, HyperlinkInfo hyperlinkInfo)
Parameters
CellRange cellRange

The cell range.
HyperlinkInfo hyperlinkInfo

The hyperlink info.
Returns
SpreadsheetHyperlink

The new hyperlink.

Add(CellRange, SpreadsheetHyperlink)

Adds the specified element when cellRange is inserted.

Declaration
protected override SpreadsheetHyperlink Add(CellRange cellRange, SpreadsheetHyperlink element)
Parameters
CellRange cellRange

The cell range.
SpreadsheetHyperlink element

The element.
Returns
SpreadsheetHyperlink

Overrides
Telerik.Windows.Documents.Spreadsheet.Model.CellRangeInsertedOrRemovedAwareCollection<Telerik.Windows.Documents.Spreadsheet.Model.SpreadsheetHyperlink>.Add(Telerik.Windows.Documents.Spreadsheet.Model.CellRange, Telerik.Windows.Documents.Spreadsheet.Model.SpreadsheetHyperlink)

Contains(SpreadsheetHyperlink)

Determines whether the collection contains the specified hyperlink.

Declaration
public bool Contains(SpreadsheetHyperlink hyperlink)
Parameters
SpreadsheetHyperlink hyperlink

The hyperlink.
Returns
System.Boolean

A value indicating whether the collection contains the specified hyperlink.

GetContainingHyperlinks(IEnumerable<CellRange>)

Gets the hyperlinks contained in the specified cell ranges.

Declaration
public IEnumerable<SpreadsheetHyperlink> GetContainingHyperlinks(IEnumerable<CellRange> cellRanges)
Parameters
System.Collections.Generic.IEnumerable<CellRange> cellRanges

The cell ranges.
Returns
System.Collections.Generic.IEnumerable<SpreadsheetHyperlink>

The collection of contained hyperlinks.

GetContainingHyperlinks(CellRange)

Gets the hyperlinks contained in the specified cell range.

Declaration
public IEnumerable<SpreadsheetHyperlink> GetContainingHyperlinks(CellRange cellRange)
Parameters
CellRange cellRange

The cell range.
Returns
System.Collections.Generic.IEnumerable<SpreadsheetHyperlink>

The collection of contained hyperlinks.

GetIntersectingHyperlinks(CellRange)

Gets the hyperlinks intersecting with the specified cell range.

Declaration
public IEnumerable<SpreadsheetHyperlink> GetIntersectingHyperlinks(CellRange cellRange)
Parameters
CellRange cellRange

The cell range.
Returns
System.Collections.Generic.IEnumerable<SpreadsheetHyperlink>

The collection of intersecting hyperlinks.

OnChanged()

Called when the collection is changed.

Declaration
protected virtual void OnChanged()

Remove(CellRange)

Removes elements when cellRange is removed.

Declaration
protected override bool Remove(CellRange cellRange)
Parameters
CellRange cellRange

The cell range.
Returns
System.Boolean

Overrides
Telerik.Windows.Documents.Spreadsheet.Model.CellRangeInsertedOrRemovedAwareCollection<Telerik.Windows.Documents.Spreadsheet.Model.SpreadsheetHyperlink>.Remove(Telerik.Windows.Documents.Spreadsheet.Model.CellRange)

Remove(SpreadsheetHyperlink)

Removes the specified hyperlink.

Declaration
public bool Remove(SpreadsheetHyperlink hyperlink)
Parameters
SpreadsheetHyperlink hyperlink

The hyperlink.
Returns
System.Boolean

The value indicating whether the remove was successful.

TryGetHyperlink(CellIndex, out SpreadsheetHyperlink)

Tries to get a hyperlink from the specified cell index.

Declaration
public bool TryGetHyperlink(CellIndex cellIndex, out SpreadsheetHyperlink hyperlink)
Parameters
CellIndex cellIndex

Index of the cell.
SpreadsheetHyperlink hyperlink

The hyperlink.
Returns
System.Boolean

The value indicating whether a hyperlink was found.

TryGetHyperlink(CellRange, out SpreadsheetHyperlink)

Tries to get a hyperlink from the specified cell range.

Declaration
public bool TryGetHyperlink(CellRange cellRange, out SpreadsheetHyperlink hyperlink)
Parameters
CellRange cellRange

The cell range.
SpreadsheetHyperlink hyperlink

The hyperlink.
Returns
System.Boolean

The value indicating whether a hyperlink was found.

TryGetHyperlinkExact(CellRange, out SpreadsheetHyperlink)

Tries to get the hyperlink from the specified cell range where the cell range has to match the hyperlink's cell range exactly.

Declaration
public bool TryGetHyperlinkExact(CellRange cellRange, out SpreadsheetHyperlink hyperlink)
Parameters
CellRange cellRange

The cell range.
SpreadsheetHyperlink hyperlink

The hyperlink.
Returns
System.Boolean

The value indicating whether a hyperlink was found.

Events

Changed

Occurs when the collection is changed.

Declaration
public event EventHandler Changed
Event Type
System.EventHandler