Class Hyperlink
java.lang.Object
org.apache.poi.ss.formula.functions.Hyperlink
- All Implemented Interfaces:
Function,Function1Arg,Function2Arg
Implementation of Excel HYPERLINK function.
In Excel this function has special behaviour - it causes the displayed cell value to behave like a hyperlink in the GUI. From an evaluation perspective however, it is very simple.
Syntax:
HYPERLINK(link_location, friendly_name)
link_location The URL of the hyperlink
friendly_name (optional) the value to display
Returns last argument. Leaves type unchanged (does not convert to StringEval).
- Author:
- Wayne Clingingsmith
-
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
Hyperlink
public Hyperlink()
-
-
Method Details
-
evaluate
Description copied from interface:Function1Arg -
evaluate
Description copied from interface:Function2Arg -
evaluate
- Specified by:
evaluatein interfaceFunction- Parameters:
args- the evaluated function arguments. Empty values are represented withBlankEvalorMissingArgEval, nevernull.srcRowIndex- row index of the cell containing the formula under evaluationsrcColumnIndex- column index of the cell containing the formula under evaluation- Returns:
- The evaluated result, possibly an
ErrorEval, nevernull. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate toDouble.NaNbe sure to translate the result toErrorEval.NUM_ERROR.
-