Top Description Constructors Methods
org.apache.poi.ss.formula.functions

public final Class Hyperlink

extends Var1or2ArgFunction
Class Inheritance
Imports
org.apache.poi.ss.formula.eval.ValueEval
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 org.apache.poi.ss.formula.eval.StringEval).

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
public ValueEval
evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0)

Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate.

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

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

Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

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

Inherited from org.apache.poi.ss.formula.functions.Var1or2ArgFunction:
evaluate

Constructor Detail

Hyperlinkback to summary
public Hyperlink()

Method Detail

evaluateback to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0)

Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate.

Doc from org.apache.poi.ss.formula.functions.Function1Arg.evaluate.

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

evaluateback to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)

Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

Doc from org.apache.poi.ss.formula.functions.Function2Arg.evaluate.

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