com.aspose.gridweb

Class GridHyperlink

java.lang.Object

com.aspose.gridweb.GridHyperlink

public class GridHyperlink
extends java.lang.Object

Encapsulates the object that represents a hyperlink.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAddress() Represents the address of a hyperlink.
java.lang.String	getAltText() Gets Alternate text for the image link,please note this is an extension attribute and can not keep in excel file
GridCellArea	getArea() Gets the range of hyperlink.
java.lang.String	getCommand() Returns or sets the self defined command value text for the specified hyperlink.
boolean	getDiscardInput() Indicates whether to discard user input at client browser when user click this CellCommand hyperlink.
java.lang.String	getImageURL() Gets Image URL for the link, there is no imageurl properties in hyperlink, so actually use TextToDisplay to record this value ,TextToDisplay will be set to <img src=value > so it will change the value of TextToDisplay
java.lang.String	getScreenTip() Returns or sets the ScreenTip text for the specified hyperlink.
java.lang.String	getTarget() Gets web link target type,please note this is an extension attribute and can not keep in excel file
java.lang.String	getTextToDisplay() Represents the text to be displayed for the specified hyperlink.
void	setAddress(java.lang.String value) Represents the address of a hyperlink.
void	setAltText(java.lang.String value) Sets Alternate text for the image link,please note this is an extension attribute and can not keep in excel file
void	setCommand(java.lang.String value) Returns or sets the self defined command value text for the specified hyperlink.
void	setDiscardInput(boolean value) Indicates whether to discard user input at client browser when user click this CellCommand hyperlink.
void	setImageURL(java.lang.String value) Sets Image URL for the link, there is no imageurl properties in hyperlink, so actually use TextToDisplay to record this value ,TextToDisplay will be set to <img src=value > so it will change the value of TextToDisplay
void	setScreenTip(java.lang.String value) Returns or sets the ScreenTip text for the specified hyperlink.
void	setTarget(java.lang.String value) Sets web link target type,please note this is an extension attribute and can not keep in excel file
void	setTextToDisplay(java.lang.String value) Represents the text to be displayed for the specified hyperlink.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAddress

public java.lang.String getAddress()

Represents the address of a hyperlink.

setAddress

public void setAddress(java.lang.String value)

Represents the address of a hyperlink.

getCommand

public java.lang.String getCommand()

Returns or sets the self defined command value text for the specified hyperlink.

setCommand

public void setCommand(java.lang.String value)

Returns or sets the self defined command value text for the specified hyperlink.

getTextToDisplay

public java.lang.String getTextToDisplay()

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

setTextToDisplay

public void setTextToDisplay(java.lang.String value)

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

getArea

public GridCellArea getArea()

Gets the range of hyperlink.

getScreenTip

public java.lang.String getScreenTip()

Returns or sets the ScreenTip text for the specified hyperlink.

setScreenTip

public void setScreenTip(java.lang.String value)

Returns or sets the ScreenTip text for the specified hyperlink.

getTarget

public java.lang.String getTarget()

Gets web link target type,please note this is an extension attribute and can not keep in excel file

setTarget

public void setTarget(java.lang.String value)

Sets web link target type,please note this is an extension attribute and can not keep in excel file

getAltText

public java.lang.String getAltText()

Gets Alternate text for the image link,please note this is an extension attribute and can not keep in excel file

setAltText

public void setAltText(java.lang.String value)

Sets Alternate text for the image link,please note this is an extension attribute and can not keep in excel file

getDiscardInput

public boolean getDiscardInput()

Indicates whether to discard user input at client browser when user click this CellCommand hyperlink. Could be used as an "undo" action.

setDiscardInput

public void setDiscardInput(boolean value)

Indicates whether to discard user input at client browser when user click this CellCommand hyperlink. Could be used as an "undo" action.

getImageURL

public java.lang.String getImageURL()

Gets Image URL for the link, there is no imageurl properties in hyperlink, so actually use TextToDisplay to record this value ,TextToDisplay will be set to <img src=value > so it will change the value of TextToDisplay

setImageURL

public void setImageURL(java.lang.String value)

Sets Image URL for the link, there is no imageurl properties in hyperlink, so actually use TextToDisplay to record this value ,TextToDisplay will be set to <img src=value > so it will change the value of TextToDisplay