com.spire.doc
Class Hyperlink

java.lang.Object
  com.spire.doc.Hyperlink

public class Hyperlink
extends java.lang.Object

Constructor Summary

Hyperlink(Field hyperlink)
Initializes a new instance of the Hyperlink class.

Method Summary

java.lang.String	getBookmarkName() Returns bookmark.
java.lang.String	getFilePath() Gets file path.
ShapeObject	getPictureToDisplay() Gets the image which will be displayed on the place of hyperlink.
java.lang.String	getTextToDisplay() Gets the specified hyperlink's visible text in a document.
HyperlinkType	getType() Returns a HyperlinkType object that indicates the link type.
java.lang.String	getUri() Returns url link.
void	setBookmarkName(java.lang.String value) Sets bookmark.
void	setFilePath(java.lang.String value) Sets file path.
void	setPictureToDisplay(ShapeObject value) Sets the image which will be displayed on the place of hyperlink.
void	setTextToDisplay(java.lang.String value) Sets the specified hyperlink's visible text in a document.
void	setType(HyperlinkType value) Sets a HyperlinkType object that indicates the link type.
void	setUri(java.lang.String value) Sets url link.

Constructor Detail

Hyperlink

public Hyperlink(Field hyperlink)

Initializes a new instance of the Hyperlink class.

Parameters:

hyperlink - The hyperlink.

Method Detail

getFilePath

public java.lang.String getFilePath()

Gets file path.

Returns:

the file path.

setFilePath

public void setFilePath(java.lang.String value)

Sets file path.

Parameters:

value - file path.

getUri

public java.lang.String getUri()

Returns url link.

Returns:

url link.

setUri

public void setUri(java.lang.String value)

Sets url link.

Parameters:

value - url link.

getBookmarkName

public java.lang.String getBookmarkName()

Returns bookmark.

Returns:

bookmark name

setBookmarkName

public void setBookmarkName(java.lang.String value)

Sets bookmark.

Parameters:

value - the bookmark name

getType

public HyperlinkType getType()

Returns a HyperlinkType object that indicates the link type.

Returns:

the HyperlinkType

setType

public void setType(HyperlinkType value)

Sets a HyperlinkType object that indicates the link type.

Parameters:

value - HyperlinkType

getTextToDisplay

public java.lang.String getTextToDisplay()

Gets the specified hyperlink's visible text in a document.

Returns:

The text to display.

setTextToDisplay

public void setTextToDisplay(java.lang.String value)

Sets the specified hyperlink's visible text in a document.

Parameters:

value - the TexttoDisplay

getPictureToDisplay

public ShapeObject getPictureToDisplay()

Gets the image which will be displayed on the place of hyperlink.

Returns:

the shapobject

setPictureToDisplay

public void setPictureToDisplay(ShapeObject value)

Sets the image which will be displayed on the place of hyperlink.

Parameters:

value - the shapobject