类: NameBox

Sheets.NameBox.NameBox

Table of contents

构造方法

• constructor

属性

• options

方法

• dispose
• getHost
• refresh

构造方法

constructor

• new NameBox(host, workbook, options?)

名称框组件

参数

属性

options

• options: INameBoxOptions

指示名称框的选项

property [enableAddCustomName] 在输入选择器中不存在的名称时是否启用添加自定义名称

property [enableNavigateToRange] 指示在输入名称或单击自定义列表项时启用导航到命名范围或绘图项

property [showCustomNameList] 指示是否显示自定义名称列表下拉指示器

property [dropDownMaxHeight] 指示下拉列表元素的最大高度

方法

dispose

▸ dispose(): void

销毁 NameBox，并解除所有事件的绑定

代码示例

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var nameBox = new GC.Spread.Sheets.NameBox.NameBox(document.getElementById('nameBox'), spread);
// do something
nameBox.dispose();

返回值

void

getHost

▸ getHost(): HTMLElement

获取名称框组件所在容器

代码示例

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var nameBox = new GC.Spread.Sheets.NameBox.NameBox(document.getElementById('nameBox'), spread);
var host = nameBox.getHost();

返回值

HTMLElement

refresh

▸ refresh(): void

刷新名称框，并将名称框值同步到工作表选择

代码示例

var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"));
var nameBox = new GC.Spread.Sheets.NameBox.NameBox(document.getElementById('nameBox'), spread);
var sheet = spread.getActiveSheet();
sheet.setSelection(0, 0, 3, 3);
nameBox.refresh();

返回值

void