removeCustomFunctionDescription Method

Removes a custom function description.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Sheet(name);
var value; // Type: any
value = instance.removeCustomFunctionDescription(name);

function removeCustomFunctionDescription( 
   name : string
) : any;

Parameters

name: The custom function description name.

Example

This example uses the removeCustomFunctionDescription method.

Javascript

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);
    var functionDes = {
        name:"FACTORIAL",
        description: "The function returns the factorial of the cells value",
        parameters:[{ name: "value" }]
    };
    activeSheet.addCustomFunctionDescription(functionDes);

activeSheet.removeCustomFunctionDescription("FACTORIAL");

Reference

Sheet type