org.apache.poi.ss.formula.functions
Class Hyperlink

java.lang.Object
  org.apache.poi.ss.formula.functions.Hyperlink

All Implemented Interfaces:

Function, Function1Arg, Function2Arg

public final class Hyperlink
extends java.lang.Object

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).

Hyperlink

public Hyperlink()

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg0)

Description copied from interface: Function1Arg

see Function.evaluate(ValueEval[], int, int)

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg0,
                          ValueEval arg1)

Description copied from interface: Function2Arg

see Function.evaluate(ValueEval[], int, int)

evaluate

public final ValueEval evaluate(ValueEval[] args,
                                int srcRowIndex,
                                int srcColumnIndex)

Specified by:

evaluate in interface Function

Parameters:

args - the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcRowIndex - row index of the cell containing the formula under evaluation

srcColumnIndex - column index of the cell containing the formula under evaluation

Returns:

The evaluated result, possibly an ErrorEval, never null. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double.NaN be sure to translate the result to ErrorEval.NUM_ERROR.