SpreadJS 13
GC.Spread.Sheets Namespace / Worksheet type / addCustomName Method
The custom name.
The formula.
The row index.
The column index.
The comment.
In This Topic
    addCustomName Method
    In This Topic
    Adds a custom name.
    Syntax
    var instance = new GC.Spread.Sheets.Worksheet(name);
    var value; // Type: any
    value = instance.addCustomName(name, formula, baseRow, baseCol, comment);
    function addCustomName( 
       name : string,
       formula : string,
       baseRow : number,
       baseCol : number,
       comment : string
    ) : any;

    Parameters

    name
    The custom name.
    formula
    The formula.
    baseRow
    The row index.
    baseCol
    The column index.
    comment
    The comment.
    Example
    This example creates custom names.
    sheet.setValue(0, 0, 1);
    sheet.setValue(0, 1, 2);
    sheet.setValue(0, 2, 3);
    sheet.addCustomName("customName1","=12", 0, 0);
    sheet.addCustomName("customName2","Average(20,45)", 0, 0);
    sheet.addCustomName("customName3", "=$A$1:$C$1", 0, 0);
    sheet.setFormula(1, 0, "customName1");
    sheet.setFormula(1, 1, "customName2");
    sheet.setFormula(1, 2, "sum(customName3)");
    See Also

    Reference

    Worksheet type