com.grapecity.documents.excel

Interface IHyperlink

public interface IHyperlink

Represents a hyperlink.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the hyperlink.
java.lang.String	getAddress() Gets the address of the target document.
java.lang.String	getEmailSubject() Gets the text string of the specified hyperlink’s e-mail subject line.
java.lang.String	getName() Returns the name of the object.
IRange	getRange() Returns the IRange object that represents the range the specified hyperlink is attached to.
java.lang.String	getScreenTip() Gets the ScreenTip text for the specified hyperlink.
IShape	getShape() Returns the IShape object that represents the shape attached to the specified hyperlink.
java.lang.String	getSubAddress() Gets the location within the document associated with the hyperlink.
java.lang.String	getTextToDisplay() Gets the text to be displayed for the specified hyperlink.
void	setAddress(java.lang.String value) Sets the address of the target document.
void	setEmailSubject(java.lang.String value) Sets the text string of the specified hyperlink’s e-mail subject line.
void	setScreenTip(java.lang.String value) Sets the ScreenTip text for the specified hyperlink.
void	setSubAddress(java.lang.String value) Sets the location within the document associated with the hyperlink.
void	setTextToDisplay(java.lang.String value) Sets the text to be displayed for the specified hyperlink.

Method Detail

getName

java.lang.String getName()

Returns the name of the object.

getRange

IRange getRange()

Returns the IRange object that represents the range the specified hyperlink is attached to.

getShape

IShape getShape()

Returns the IShape object that represents the shape attached to the specified hyperlink.

getAddress

java.lang.String getAddress()

Gets the address of the target document.

setAddress

void setAddress(java.lang.String value)

Sets the address of the target document.

getEmailSubject

java.lang.String getEmailSubject()

Gets the text string of the specified hyperlink’s e-mail subject line. The subject line is appended to the hyperlink’s address.

setEmailSubject

void setEmailSubject(java.lang.String value)

Sets the text string of the specified hyperlink’s e-mail subject line. The subject line is appended to the hyperlink’s address.

getScreenTip

java.lang.String getScreenTip()

Gets the ScreenTip text for the specified hyperlink.

setScreenTip

void setScreenTip(java.lang.String value)

Sets the ScreenTip text for the specified hyperlink.

getSubAddress

java.lang.String getSubAddress()

Gets the location within the document associated with the hyperlink.

setSubAddress

void setSubAddress(java.lang.String value)

Sets the location within the document associated with the hyperlink.

getTextToDisplay

java.lang.String getTextToDisplay()

Gets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

setTextToDisplay

void setTextToDisplay(java.lang.String value)

Sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

delete

void delete()

Deletes the hyperlink.