com.spire.xls.core.spreadsheet
Class XlsHyperLink

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.XlsHyperLink

All Implemented Interfaces:

IHyperLink

Direct Known Subclasses:

HyperLink

public class XlsHyperLink
extends XlsObject
implements IHyperLink

Constructor Summary

XlsHyperLink(java.lang.Object parent)

Method Summary

java.lang.String	getAddress() Returns the address of the target document.
int	getFirstColumn()
int	getFirstRow()
int	getLastColumn()
int	getLastRow()
java.lang.String	getName() Returns or sets the name of the object.
IXLSRange	getRange() Returns a Range object that represents the range the specified hyperlink is attached to.
java.lang.String	getScreenTip() Returns or sets the ScreenTip text for the specified hyperlink.
java.lang.String	getSubAddress() Returns or sets the location within the document associated with the hyperlink.
java.lang.String	getTextToDisplay() Returns or sets the text to be displayed for the specified hyperlink.
HyperLinkType	getType() Returns or sets the object type.
java.lang.String	getUnicodePath() Gets/sets an optional string of Unicode characters that specifies the complete file path.
void	setAddress(java.lang.String address) Sets the address of the target document.
void	setAddress(java.lang.String strAddress, boolean bSetText) Sets address property.
void	setInnerSubAddress(java.lang.String strSubAddress) Sets sub address property.
void	setRange(IXLSRange value) Sets a Range object that represents the range the specified hyperlink is attached to.
void	setScreenTip(java.lang.String value) Returns or sets the ScreenTip text for the specified hyperlink.
void	setSubAddress(java.lang.String value) Returns or sets the location within the document associated with the hyperlink.
void	setTextToDisplay(java.lang.String value) Returns or sets the text to be displayed for the specified hyperlink.
void	setUnicodePath(java.lang.String value) Gets/sets an optional string of Unicode characters that specifies the complete file path.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Constructor Detail

XlsHyperLink

public XlsHyperLink(java.lang.Object parent)

Method Detail

getAddress

public java.lang.String getAddress()

Returns the address of the target document.

Specified by:

getAddress in interface IHyperLink

setAddress

public void setAddress(java.lang.String address)

Sets the address of the target document.

getName

public java.lang.String getName()

Returns or sets the name of the object.

Specified by:

getName in interface IHyperLink

getRange

public IXLSRange getRange()

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

Specified by:

getRange in interface IHyperLink

setRange

public void setRange(IXLSRange value)

Sets a Range object that represents the range the specified hyperlink is attached to.

getScreenTip

public java.lang.String getScreenTip()

Returns or sets the ScreenTip text for the specified hyperlink.

Specified by:

getScreenTip in interface IHyperLink

setScreenTip

public void setScreenTip(java.lang.String value)

Returns or sets the ScreenTip text for the specified hyperlink.

getSubAddress

public java.lang.String getSubAddress()

Returns or sets the location within the document associated with the hyperlink.

Specified by:

getSubAddress in interface IHyperLink

setSubAddress

public void setSubAddress(java.lang.String value)

Returns or sets the location within the document associated with the hyperlink.

setAddress

public void setAddress(java.lang.String strAddress,
                       boolean bSetText)

Sets address property.

Parameters:

strAddress - Address to set.

bSetText - Indicates whether we should set Text property of // the TopLeft cell with this hyperlink.

setInnerSubAddress

public void setInnerSubAddress(java.lang.String strSubAddress)

Sets sub address property.

Parameters:

strSubAddress - Sub address to set.

getTextToDisplay

public java.lang.String getTextToDisplay()

Returns or sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

Specified by:

getTextToDisplay in interface IHyperLink

setTextToDisplay

public void setTextToDisplay(java.lang.String value)

Returns or sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

getType

public HyperLinkType getType()

Returns or sets the object type.

Specified by:

getType in interface IHyperLink

getFirstRow

public int getFirstRow()

getFirstColumn

public int getFirstColumn()

getLastRow

public int getLastRow()

getUnicodePath

public java.lang.String getUnicodePath()

Gets/sets an optional string of Unicode characters that specifies the complete file path. When the property Type is not HyperLinkType.File, this property is invalid.

setUnicodePath

public void setUnicodePath(java.lang.String value)

Gets/sets an optional string of Unicode characters that specifies the complete file path. When the property Type is not HyperLinkType.File, this property is invalid.

getLastColumn

public int getLastColumn()