rangeToFormula Method

In This Topic

Syntax

Javascript (Usage)
Javascript (Specification)

var value; // Type: string
value = GC.Spread.Sheets.CalcEngine.rangeToFormula(range, baseRow, baseCol, rangeReferenceRelative, useR1C1);

function rangeToFormula( 
   range : Range,
   (optional) baseRow : number,
   (optional) baseCol : number,
   (optional) rangeReferenceRelative : GC.Spread.CalcEngine.RangeReferenceRelative,
   (optional) useR1C1 : boolean
) : string;

Parameters

range: The cell range in the sheet.
baseRow: The base row index of the formula.
baseCol: The base column index of the formula.
rangeReferenceRelative: Whether the range reference is relative or absolute.
useR1C1: Whether to use the r1c1 reference style.

Return Value

The formula string that refers to the specified cell range.

Example

Javascript

var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
sheet = spread.getSheet(0);
// setting value
sheet.setValue(0, 0, 1, 3);
sheet.setValue(1, 0, 50, 3);
sheet.setValue(2, 0, 100, 3);
sheet.setValue(3, 0, 2, 3);
sheet.setValue(4, 0, 60, 3);
sheet.setValue(5, 0, 90, 3);
sheet.clearSelection();
// adding selection
sheet.addSelection(2, 0, 3, 1);
var range = sheet.getSelections();
// Getting range string
var rangeStr = GC.Spread.Sheets.CalcEngine.rangeToFormula(range[0]);
// creating formula using selected range
var formula = "Sum(" + rangeStr + ")";
// setting formula in Sheet's cell
sheet.setFormula(5, 5, formula, GC.Spread.Sheets.SheetArea.viewport);

Remarks

Reference

CalcEngine type

Product Support Forum | Print this page