クラス: FormulaTextBox

Sheets.FormulaTextBox.FormulaTextBox

Table of contents

コンストラクタ

• constructor

メソッド

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

コンストラクタ

constructor

• new FormulaTextBox(host, options?)

数式テキストボックスを表します。

実例

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());
}

パラメータ

名前	型	説明
host	HTMLElement	DOM要素。INPUT、TEXTAREA、または編集可能なDIVを使用できます。
options?	IFormulaTextBoxOptions	-

メソッド

add

▸ add(functionDescription): void

カスタム関数の記述を追加します。

パラメータ

名前	型	説明
functionDescription	IFunctionDescription	追加する関数の記述。配列を使用できます。詳細については、「解説」を参照してください。

戻り値

void

---

autoComplete

▸ autoComplete(value?): boolean

テキストボックスでオートコンプリートを使用するかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	編集時にオートコンプリートを使用するかどうか。

戻り値

boolean

値が設定されていない場合は、テキストボックスでオートコンプリートを使用するかどうかを返します。値が設定されている場合、戻り値はありません。

---

destroy

▸ destroy(): void

数式テキストボックスからホストを削除し、すべてのイベント連結を解除します。

戻り値

void

---

refresh

▸ refresh(ignoreEditing?): void

数式テキストボックスをアクティブセルで更新します。

パラメータ

名前	型
ignoreEditing?	boolean

戻り値

void

---

remove

▸ remove(name): void

カスタム関数の記述を削除します。

パラメータ

名前	型	説明
name	string	カスタム関数の記述名。

戻り値

void

---

showHelp

▸ showHelp(value?): any

関数のヘルプチップを表示するかどうかを取得または設定します。

パラメータ

名前	型	説明
value?	boolean	編集時に関数のヘルプチップを表示するかどうか。

戻り値

any

値が設定されていない場合は、テキストボックスの編集時に関数のヘルプチップを表示するかどうかを返します。値が設定されている場合、戻り値はありません。

---

text

▸ text(value?): string

テキストを取得または設定します。

パラメータ

名前	型	説明
value?	string	テキスト。

戻り値

string

値が設定されていない場合は、テキストを返します。値が設定されている場合、戻り値はありません。

---

workbook

▸ workbook(value?): Workbook

数式テキストボックスを処理するWorkbookコンポーネントを取得または設定します。

実例

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);
};

パラメータ

名前	型	説明
value?	Workbook	Workbookコンポーネント。

戻り値

Workbook

値が設定されていない場合は、Workbookコンポーネントを返します。値が設定されている場合、戻り値はありません。