getCustomFunction Method

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Spread(host, options);
var value; // Type: Function
value = instance.getCustomFunction(name);

function getCustomFunction( 
   name : string
) : Function;

Parameters

name: The custom function name.

Return Value

The custom function.

This example uses the getCustomFunction method.

Javascript

// Type =factorial(5) in a cell to see the result
function FactorialFunction() {
this.name = "FACTORIAL";
this.maxArgs = 1;
this.minArgs = 1;
}
FactorialFunction.prototype = new GcSpread.Sheets.Calc.Functions.Function();
FactorialFunction.prototype.evaluate = function (args) {
var result = 1;
if (args.length === 1 && !isNaN(parseInt(args[0]))) {
for (var i = 1; i < args[0]; i++) {
result = i * result;
}
return result;
}
return "#VALUE!";
}
var factorial = new FactorialFunction();
spread.addCustomFunction(factorial);
activeSheet.getCell(0,0).formula("factorial(5)");
var name = spread.getCustomFunction("factorial");
alert(name);

Reference

Spread type