GrapeCity.Documents.Excel.IHyperlinks

Interface IHyperlinks

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents the collection of hyperlinks for a worksheet or range. Each hyperlink is represented by the IHyperlink object.

public interface IHyperlinks : IEnumerable

Inherited Members

System.Collections.IEnumerable.GetEnumerator()

Properties

Count

Returns the number of objects in the collection.

int Count { get; }

Property Value

int

this[int]

Gets the IHyperlink by index.

IHyperlink this[int index] { get; }

Parameters

index int

The index of the collection.

Property Value

IHyperlink

Returns the IHyperlink object.

Methods

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

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

IHyperlink Add(IShape shape, string address, string subAddress = "", string screenTip = "", string textToDisplay = "")

Parameters

shape IShape

Required IShapeThe shape for the hyperlink.

address string

Required String. The address of the hyperlink.

subAddress string

Optional Object. The subaddress of the hyperlink.

screenTip string

Optional Object. The screen tip to be displayed when the mouse pointer is paused over the hyperlink.

textToDisplay string

Optional Object. The text to be displayed for the hyperlink.

Returns

IHyperlink

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

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

IHyperlink Add(IRange anchor, string address, string subAddress = "", string screenTip = "", string textToDisplay = "")

Parameters

anchor IRange

Required IRangeThe anchor for the hyperlink.

address string

Required String. The address of the hyperlink.

subAddress string

Optional Object. The subaddress of the hyperlink.

screenTip string

Optional Object. The screen tip to be displayed when the mouse pointer is paused over the hyperlink.

textToDisplay string

Optional Object. The text to be displayed for the hyperlink.

Returns

IHyperlink

Delete()

Deletes the object.

void Delete()