com.grapecity.documents.excel

Interface IHyperlinks

All Superinterfaces:

java.lang.Iterable<IHyperlink>

public interface IHyperlinks
extends java.lang.Iterable<IHyperlink>

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

Method Summary

Modifier and Type	Method and Description
IHyperlink	add(IRange anchor, java.lang.String address) Adds a hyperlink to the specified range (IHyperlink object).
IHyperlink	add(IRange anchor, java.lang.String address, java.lang.String subAddress, java.lang.String screenTip, java.lang.String textToDisplay) Adds a hyperlink to the specified range (IHyperlink object).
IHyperlink	add(IShape shape, java.lang.String address) Adds a hyperlink to the specified shape (IHyperlink object).
IHyperlink	add(IShape shape, java.lang.String address, java.lang.String subAddress, java.lang.String screenTip, java.lang.String textToDisplay) Adds a hyperlink to the specified shape (IHyperlink object).
void	delete() Deletes the object.
IHyperlink	get(int index) Gets the IHyperlink by index.
int	getCount() Returns the number of objects in the collection.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

get

IHyperlink get(int index)

Gets the IHyperlink by index.

Parameters:

index - The index of the collection.

Returns:

Returns the IHyperlink object.

getCount

int getCount()

Returns the number of objects in the collection.

add

IHyperlink add(IRange anchor,
               java.lang.String address)

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

Parameters:

anchor - Required IRangeThe anchor for the hyperlink.

address - Required String. The address of the hyperlink.

add

IHyperlink add(IRange anchor,
               java.lang.String address,
               java.lang.String subAddress,
               java.lang.String screenTip,
               java.lang.String textToDisplay)

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

Parameters:

anchor - Required IRangeThe anchor for the hyperlink.

address - Required String. The address of the hyperlink.

subAddress - Optional Object. The subaddress of the hyperlink.

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

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

add

IHyperlink add(IShape shape,
               java.lang.String address)

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

Parameters:

shape - Required IShapeThe shape for the hyperlink.

address - Required String. The address of the hyperlink.

add

IHyperlink add(IShape shape,
               java.lang.String address,
               java.lang.String subAddress,
               java.lang.String screenTip,
               java.lang.String textToDisplay)

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

Parameters:

anchor - Required IRangeThe shape for the hyperlink.

address - Required String. The address of the hyperlink.

subAddress - Optional Object. The subaddress of the hyperlink.

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

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

delete

void delete()

Deletes the object.