GrapeCity.Documents.Excel.IHyperlinks

IHyperlinks Interface

Represents the collection of hyperlinks for a worksheet, range, or shape.

Each hyperlink in the collection is represented by an IHyperlink object. Use this interface to add, access, iterate, or delete hyperlinks that are attached to a worksheet, a cell, a range, or a shape.

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public interface IHyperlinks : IEnumerable

Public Interface IHyperlinks
    Inherits IEnumerable

Examples

IHyperlinks hyperlinks = worksheet.Range["A1:B2"].Hyperlinks;
hyperlinks.Add(worksheet.Range["A1"], "https://www.example.com/", null, "Open website", "Example");
IHyperlink hyperlink = hyperlinks[0];

Properties

Name	Description
Count	Gets the number of objects in the collection. For an IHyperlinks collection, this value indicates how many IHyperlink objects are contained in the worksheet or range.
this[int]	Gets the IHyperlink by index. The index is zero-based. If the index is outside the collection, this property returns null.

Name

Description

Count

Gets the number of objects in the collection.

For an IHyperlinks collection, this value indicates how many IHyperlink objects are contained in the worksheet or range.

this[int]

Gets the IHyperlink by index.

The index is zero-based. If the index is outside the collection, this property returns null.

Methods

Name Description

Name	Description
Add(IShape, string, string, string, string)	Adds a hyperlink to the specified shape (IHyperlink object). Use this method to attach a hyperlink to a shape such as an auto shape, chart, connector, picture, or group shape. The hyperlink target is defined by `address` and `subAddress`, and the optional screen tip and display text can be used to customize the user-facing content.
Add(IRange, string, string, string, string)	Adds a hyperlink to the specified range (IHyperlink object). Use this method to attach a hyperlink to the specified anchor range.
Delete()	Deletes the hyperlinks in this collection. When this collection belongs to a worksheet, this method deletes all hyperlinks in the worksheet. When it belongs to a range, this method deletes the hyperlinks in that range.

Add(IShape, string, string, string, string)

Adds a hyperlink to the specified shape (IHyperlink object).

Use this method to attach a hyperlink to a shape such as an auto shape, chart, connector, picture, or group shape. The hyperlink target is defined by address and subAddress, and the optional screen tip and display text can be used to customize the user-facing content.

Add(IRange, string, string, string, string)

Adds a hyperlink to the specified range (IHyperlink object).

Use this method to attach a hyperlink to the specified anchor range.

Delete()

Deletes the hyperlinks in this collection.

When this collection belongs to a worksheet, this method deletes all hyperlinks in the worksheet. When it belongs to a range, this method deletes the hyperlinks in that range.