Interface IHyperlink
public interface IHyperlink
Represents a hyperlink.
-
Method Summary
void
Gets the address of the target document.
Gets the text string of the specified hyperlink’s e-mail subject line.
Returns the name of the object.
Returns the
IRange
object that represents the range the specifiedhyperlink is attached to.
Gets the ScreenTip text for the specified hyperlink.
Returns the IShape
object that represents the shape attached to the specified hyperlink.
Gets the location within the document associated with the hyperlink.
Gets the text to be displayed for the specified hyperlink.
void
Sets the address of the target document.
void
Sets the text string of the specified hyperlink’s e-mail subject line.
void
Sets the ScreenTip text for the specified hyperlink.
void
Sets the location within the document associated with the hyperlink.
void
Sets the text to be displayed for the specified hyperlink.
-
Method Details
-
getName
Returns the name of the object.
-
getRange
Returns the
IRange
object that represents the range the specifiedhyperlink is attached to.
-
getShape
Returns the IShape
object that represents the shape attached to the specified hyperlink.
-
getAddress
Gets the address of the target document.
-
setAddress
Sets the address of the target document.
-
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(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
Gets the ScreenTip text for the specified hyperlink.
-
setScreenTip
void setScreenTip(String value)
Sets the ScreenTip text for the specified hyperlink.
-
getSubAddress
Gets the location within the document associated with the hyperlink.
-
setSubAddress
void setSubAddress(String value)
Sets the location within the document associated with the hyperlink.
-
getTextToDisplay
Gets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
-
setTextToDisplay
void setTextToDisplay(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.