GC.Spread.Sheets.CellTypes.CheckBox

类: CheckBox

Sheets.CellTypes.CheckBox

继承关系

Base

↳ CheckBox

构造方法

constructor

属性

typeName

方法

构造方法

constructor

• new CheckBox()

一个复选框单元格

代码示例

//本示例创建一个复选框单元格
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

Overrides

Base.constructor

属性

typeName

• typeName: string

支持序列化的类型名称字符串

继承自

Base.typeName

方法

activateEditor

▸ activateEditor(editorContext, cellStyle, cellRect, context?): void

激活编辑器，包括为编辑器设置属性或属性以及为编辑器绑定事件

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由createEditorElement方法创建的DOM元素
`cellStyle`	`Style`	单元格的实际样式
`cellRect`	`Rect`	单元格的布局信息
`context?`	`any`	与单元格类型关联的上下文

返回值

void

继承自

Base.activateEditor

boxSize

▸ boxSize(value?): any

获取或设置复选框大小的值

代码示例

// This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

参数

属性名	类型	说明
`value?`	`string` \| `number`	复选框的大小。此值支持数字和“auto”

返回值

any

如果未设置值，返回复选框的大小

caption

▸ caption(value?): any

获取或设置单元格类型的标题

代码示例

//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

参数

属性名	类型	说明
`value?`	`string`	单元格类型的标题

返回值

any

如果未设置值，返回标题；否则，返回复选框单元类型

createEditorElement

▸ createEditorElement(context?): HTMLElement

创建一个DOM元素然后返回它

参数

属性名	类型	说明
`context?`	`any`	与单元格类型相关的上下文

返回值

HTMLElement

DOM 容器

继承自

Base.createEditorElement

deactivateEditor

▸ deactivateEditor(editorContext, context?): void

停用编辑器，例如编辑器的事件解绑

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由CreateEdoditorelement方法创建的DOM元素
`context?`	`any`	与单元格类型相关的上下文

返回值

void

继承自

Base.deactivateEditor

focus

▸ focus(editorContext, context?): void

聚焦编辑器 DOM 元素

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由CreateEdoditorelement方法创建的DOM元素
`context?`	`any`	与单元格类型相关的上下文

返回值

void

继承自

Base.focus

format

▸ format(value, format, formattedData?, context?): string

格式为带有指定格式的值为字符串

参数

属性名	类型	说明
`value`	`any`	The object value to format.
`format`	`string` \| `GeneralFormatter`	格式
`formattedData?`	`FormattedData`	待格式化的数据
`context?`	`any`	与单元格类型相关的上下文

返回值

string

格式化后的字符串

继承自

Base.format

fromJSON

▸ fromJSON(settings): void

从指定的 JSON 字符串加载对象状态

参数

属性名	类型	说明
`settings`	`any`	反序列化后的设置

返回值

void

继承自

Base.fromJSON

getAutoFitHeight

▸ getAutoFitHeight(value, text, cellStyle, zoomFactor, context?): number

获取可用于处理行的自动高度

参数

属性名	类型	说明
`value`	`any`	值
`text`	`string`	文本
`cellStyle`	`Style`	实际值
`zoomFactor`	`number`	当前表单缩放比例
`context?`	`any`	与单元格类型相关的上下文

返回值

number

处理行的自动高度

继承自

Base.getAutoFitHeight

getAutoFitWidth

▸ getAutoFitWidth(value, text, cellStyle, zoomFactor, context?): number

获取可用于处理列的自动宽度

参数

属性名	类型	说明
`value`	`any`	值
`text`	`string`	文本
`cellStyle`	`Style`	实际值
`zoomFactor`	`number`	当前表单缩放比例
`context?`	`any`	与单元格类型相关的上下文

返回值

number

处理列的自动宽度

继承自

Base.getAutoFitWidth

getEditorValue

▸ getEditorValue(editorContext, context?): any

返回编辑器的值

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由CreateEdoditorelement方法创建的DOM元素
`context?`	`any`	与单元格类型相关的上下文

返回值

any

编辑器的值

继承自

Base.getEditorValue

getHitInfo

▸ getHitInfo(x, y, cellStyle, cellRect, context?): IHitTestCellTypeHitInfo

获取单元格类型的 HitTest 信息

参数

属性名	类型	说明
`x`	`number`	x-指针相对于画布的当前位置的坐标
`y`	`number`	y-指针相对于画布的当前位置的坐标
`cellStyle`	`Style`	当前单元格实际样式
`cellRect`	`Rect`	当前单元格布局
`context?`	`any`	与单元格类型相关的上下文

返回值

IHitTestCellTypeHitInfo

返回一个包含以下参数的对象：x、y、row、col、cellRect 和 sheetArea，以及指示 isReservedLocation 的值如果击中测试在单元格类型需要处理的特殊区域内，则 isReservedLocation 为 true；否则为 false

继承自

Base.getHitInfo

isEditingValueChanged

▸ isEditingValueChanged(oldValue, newValue, context?): boolean

编辑值是否已更改

参数

属性名	类型	说明
`oldValue`	`any`	旧值
`newValue`	`any`	新值
`context?`	`any`	与单元格类型相关的上下文

返回值

boolean

true 如果 oldvalue 等于 newValue；否则，false

继承自

Base.isEditingValueChanged

isImeAware

▸ isImeAware(context?): boolean

该单元格类型是否响应 IME

参数

属性名	类型	说明
`context?`	`any`	与单元格类型相关的上下文

返回值

boolean

true 如果单元格类型响应 IME；否则，false

继承自

Base.isImeAware

isReservedKey

▸ isReservedKey(e, context?): boolean

单元类型是否处理键盘事件本身

参数

属性名	类型	说明
`e`	`KeyboardEvent`	键盘事件
`context?`	`any`	与单元格类型相关的上下文

返回值

boolean

如果单元格类型处理键盘事件本身，则返回true；否则，false

继承自

Base.isReservedKey

isThreeState

▸ isThreeState(value?): any

获取或设置一个指示复选框是否支持三个状态的值

代码示例

//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

参数

属性名	类型	说明
`value?`	`boolean`	复选框是否支持三个状态

返回值

any

如果未设置值，则返回复选框是否支持三个状态；否则，返回复选框单元类型

paint

▸ paint(ctx, value, x, y, w, h, style, context?): void

在画布上绘制单元格

参数

属性名	类型	说明
`ctx`	`CanvasRenderingContext2D`	画布上下文
`value`	`any`	单元格值
`x`	`number`	x-相对画布的坐标
`y`	`number`	y-相对画布的坐标
`w`	`number`	宽度
`h`	`number`	高度
`style`	`Style`	实际样式
`context?`	`any`	与单元格类型相关的上下文

返回值

void

继承自

Base.paint

paintContent

▸ paintContent(ctx, value, x, y, w, h, style, context?): void

在画布上绘制单元格内容

参数

属性名	类型	说明
`ctx`	`CanvasRenderingContext2D`	画布上下文
`value`	`any`	单元格值
`x`	`number`	x-相对画布的坐标
`y`	`number`	y-相对画布的坐标
`w`	`number`	宽度
`h`	`number`	高度
`style`	`Style`	实际样式
`context?`	`any`	与单元格类型相关的上下文

返回值

void

继承自

Base.paintContent

parse

▸ parse(text, formatStr, context?): any

根据指定的字符串格式化

参数

属性名	类型	说明
`text`	`string`	解析字符串
`formatStr`	`string`	格式字符串
`context?`	`any`	与单元格类型相关的上下文

返回值

any

格式化后的对象

继承自

Base.parse

processKeyDown

▸ processKeyDown(event, context?): boolean

绘制模式下处理 KeyDown 事件

参数

属性名	类型	说明
`event`	`KeyboardEvent`	键盘事件
`context?`	`any`	与单元格类型相关的上下文

返回值

boolean

如果该过程成功，则返回true；否则，false

继承自

Base.processKeyDown

processKeyUp

▸ processKeyUp(event, context?): boolean

绘制模式下处理 KeyUp 事件

参数

属性名	类型	说明
`event`	`KeyboardEvent`	键盘事件
`context?`	`any`	与单元格类型相关的上下文

返回值

boolean

如果该过程成功，则返回true；否则，false

继承自

Base.processKeyUp

processMouseDown

▸ processMouseDown(hitInfo): boolean

绘制模式下处理 MouseDown 事件

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	返回 HitTest 信息

返回值

boolean

如果该过程成功，则返回true；否则，false

继承自

Base.processMouseDown

processMouseEnter

▸ processMouseEnter(hitInfo): boolean

绘制模式下处理 MouseEnter 事件

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	返回 HitTest 信息

返回值

boolean

如果该过程成功，则返回true；否则，false

继承自

Base.processMouseEnter

processMouseLeave

▸ processMouseLeave(hitInfo): boolean

绘制模式下处理 MouseLeave 事件

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	返回 HitTest 信息

返回值

boolean

如果该过程成功，则返回true；否则，false

继承自

Base.processMouseLeave

processMouseMove

▸ processMouseMove(hitInfo): boolean

绘制模式下处理 MouseMove 事件

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	返回 HitTest 信息

返回值

boolean

如果该过程成功，则返回true；否则，false

继承自

Base.processMouseMove

processMouseUp

▸ processMouseUp(hitInfo): boolean

绘制模式下处理 MouseUp 事件

参数

属性名	类型	说明
`hitInfo`	`IHitTestCellTypeHitInfo`	返回 HitTest 信息

返回值

boolean

如果该过程成功，则返回true；否则，false

继承自

Base.processMouseUp

selectAll

▸ selectAll(editorContext, context?): void

选择编辑器DOM元素中的所有文本

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由CreateEdoditorelement方法创建的DOM元素
`context?`	`any`	与单元格类型相关的上下文

返回值

void

继承自

Base.selectAll

setEditorValue

▸ setEditorValue(editorContext, value, context?): void

设置编辑器值

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由CreateEdoditorelement方法创建的DOM元素
`value`	`any`	活动单元格的值
`context?`	`any`	与单元格类型相关的上下文

返回值

void

继承自

Base.setEditorValue

textAlign

▸ textAlign(value?): any

获取或设置与复选框相对于复选框的文本对齐

代码示例

//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

参数

属性名	类型	说明
`value?`	`CheckBoxTextAlign`	相对于复选框的文本对齐

返回值

any

如果未设置值，请返回与复选框相对于复选框的文本对齐；否则，返回复选框单元类型

textFalse

▸ textFalse(value?): any

当单元格值为false时，获取或设置单元格中的文本

代码示例

//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

参数

属性名	类型	说明
`value?`	`string`	当单元格值为`false`时，返回单元格中的文本

返回值

any

如果未设置值，请在单元格值为 false时返回单元格中的文本。如果设置了值，请返回复选框单元格

textIndeterminate

▸ textIndeterminate(value?): any

当单元格值不确定时，获取或设置了单元格中的文本（true和false）

代码示例

//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

参数

属性名	类型	说明
`value?`	`string`	当单元格值不确定时，返回单元格中的文本

返回值

any

如果未设置值，请在单元格值不确定时返回单元格中的文本。如果设置了值，请返回复选框单元格

textTrue

▸ textTrue(value?): any

当单元格值为true时获取或设置单元格中的文本

代码示例

//This example creates a check box cell.
var cellType1 = new GC.Spread.Sheets.CellTypes.CheckBox();
cellType1.caption("caption");
cellType1.textTrue("true");
cellType1.textFalse("false");
cellType1.textIndeterminate("indeterminate");
cellType1.textAlign(GC.Spread.Sheets.CellTypes.CheckBoxTextAlign.bottom);
cellType1.isThreeState(true);
cellType1.boxSize(20);
activeSheet.getCell(1, 1).cellType(cellType1);

参数

属性名	类型	说明
`value?`	`string`	单元格值为`true`时的文本

返回值

any

如果未设置值，请在单元格值为true时返回文本。如果设置了值，请返回复选框单元格

toJSON

▸ toJSON(): any

将对象状态保存为JSON字符串

返回值

any

单元格类型数据

继承自

Base.toJSON

updateEditor

▸ updateEditor(editorContext, cellStyle, cellRect, context?): Rect

更新编辑器的大小

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由createEditorElement方法创建的DOM元素
`cellStyle`	`Style`	单元格的实际样式
`cellRect`	`Rect`	单元格的布局信息
`context?`	`any`	与单元格类型关联的上下文

返回值

Rect

返回单元格包装器元素的新大小，它应包含两个属性"width"和 "height"

继承自

Base.updateEditor

updateEditorContainer

▸ updateEditorContainer(editorContext, editorBounds, cellStyle): void

更新单元格wrapper元素的大小

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由createEditorElement方法创建的DOM元素
`editorBounds`	`Rect`	单元格wrapper元素的新大小
`cellStyle`	`Style`	单元格的实际样式

返回值

void

继承自

Base.updateEditorContainer

updateImeMode

▸ updateImeMode(editorContext, imeMode, context?): void

更新编辑器的ime模式

参数

属性名	类型	说明
`editorContext`	`HTMLElement`	由createEditorElement方法创建的DOM元素
`imeMode`	`ImeMode`	单元格实际样式中的ime模式
`context?`	`any`	与单元格类型关联的上下文

返回值

void

继承自

Base.updateImeMode

GC.Spread.Sheets.CellTypes.CheckBox

类: CheckBox

继承关系

Table of contents

构造方法

属性

方法

构造方法

constructor

Overrides

属性

typeName

继承自

方法

activateEditor

参数

返回值

继承自

boxSize

参数

返回值

caption

参数

返回值

createEditorElement

参数

返回值

继承自

deactivateEditor

参数

返回值

继承自

focus

参数

返回值

继承自

format

参数

返回值

继承自

fromJSON

参数

返回值

继承自

getAutoFitHeight

参数

返回值

继承自

getAutoFitWidth

参数

返回值

继承自

getEditorValue

参数

返回值

继承自

getHitInfo

参数

返回值

继承自

isEditingValueChanged

参数

返回值

继承自

isImeAware

参数

返回值

继承自

isReservedKey

参数

返回值

继承自

isThreeState

参数

返回值

paint

参数

返回值

继承自

paintContent