Class: FormulaTextBox

Sheets.FormulaTextBox.FormulaTextBox

Table of contents

Constructors

• constructor

Methods

• add
• autoComplete
• destroy
• refresh
• remove
• showHelp
• text
• workbook

Constructors

constructor

• new FormulaTextBox(host, options?)

Represents a formula text box.

example

window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"), { sheetCount: 1 });
     rangeSelector = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(document.getElementById("ftb"), {rangeSelectMode: true});
     rangeSelector.workbook(spread);
}
function buttonClick(){
     alert(rangeSelector.text());
}

Parameters

Name	Type	Description
host	HTMLElement	The DOM element. It can be INPUT, TEXTAREA, or editable DIV.
options?	IFormulaTextBoxOptions	-

Methods

add

▸ add(functionDescription): void

Adds a custom function description.

Parameters

Name	Type	Description
functionDescription	IFunctionDescription | IFunctionDescription[]	The function description to add. This can be an array. See the Remarks for more information.

Returns

void

---

autoComplete

▸ autoComplete(value?): boolean

Gets or sets whether the text box uses automatic complete.

example

var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 2 });
var div = document.createElement('div');
div.id = 'fbx';
div.style.width = '300px';
div.style.height = '50px';
div.setAttribute('contentEditable', 'true');
document.getElementById('panel').appendChild(div);
var formulaTextBox = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(div);
formulaTextBox.workbook(spread);
formulaTextBox.autoComplete(false);

// input "=SUM" formula prefix in the formula text box input element, the func hint box will not show

Parameters

Name	Type
value?	boolean

Returns

boolean

If no value is set, returns whether the text box uses auto complete; otherwise, there is no return value.

---

destroy

▸ destroy(): void

Removes host from formula text box and removes all binding events.

Returns

void

---

refresh

▸ refresh(ignoreEditing?): void

refresh the formula text box with the active cell.

Parameters

Name	Type
ignoreEditing?	boolean

Returns

void

---

remove

▸ remove(name): void

Removes a custom function description.

Parameters

Name	Type	Description
name	string	The custom function description name.

Returns

void

---

showHelp

▸ showHelp(value?): any

Gets or sets whether to display the function's help tip.

example

var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 2 });
var div = document.createElement('div');
div.id = 'fbx';
div.style.width = '300px';
div.style.height = '50px';
div.setAttribute('contentEditable', 'true');
document.getElementById('panel').appendChild(div);
var formulaTextBox = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(div);
formulaTextBox.workbook(spread);
formulaTextBox.showHelp(false);

// input "=SUM" formula prefix in the formula text box input element, the func hint (auto complete) box iwll show, but the help func will not show

Parameters

Name	Type
value?	boolean

Returns

any

If no value is set, returns whether the text box displays the function's help tip when editing; otherwise, there is no return value.

---

text

▸ text(value?): string

Gets or sets the text.

example

var spread = new GC.Spread.Sheets.Workbook(_getElementById('ss'), { sheetCount: 2 });
var div = document.createElement('div');
div.id = 'fbx';
div.style.width = '300px';
div.style.height = '50px';
div.setAttribute('contentEditable', 'true');
document.getElementById('panel').appendChild(div);
var formulaTextBox = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(div);
formulaTextBox.workbook(spread);
formulaTextBox.text('this is text');
// worksheet will be in edit status with the text value and formula text box input box will also show the text value.
console.log(formulaTextBox.text()); // 'this is text'

Parameters

Name	Type
value?	string

Returns

string

If no value is set, returns the text; otherwise, there is no return value.

---

workbook

▸ workbook(value?): Workbook

Gets or sets the Workbook component to work with the formula text box.

example

window.onload = function(){
     var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
     var activeSheet = spread.getActiveSheet();
     activeSheet.setArray(0, 0, [1, 2, 3, 4, 5]);
     var fbx = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(document.getElementById("formulaTextBox"));
     fbx.workbook(spread);
};

Parameters

Name	Type	Description
value?	Workbook	The Workbook component.

Returns

Workbook

If no value is set, returns the workbook component; otherwise, there is no return value.