类: CellRange

Spread.Sheets.CellRange

Table of contents

构造方法

• constructor

属性

• col
• colCount
• row
• rowCount
• sheet
• sheetArea

方法

• altText
• backColor
• backgroundImage
• backgroundImageLayout
• bindingPath
• borderBottom
• borderLeft
• borderRight
• borderTop
• cellButtons
• cellPadding
• cellType
• clear
• comment
• defaultValue
• diagonalDown
• diagonalUp
• dropDowns
• font
• fontFamily
• fontSize
• fontStyle
• fontWeight
• foreColor
• formatter
• formula
• hAlign
• height
• imeMode
• isVerticalText
• labelOptions
• locked
• mask
• quotePrefix
• resizable
• setBorder
• setStyle
• setStyleName
• showEllipsis
• shrinkToFit
• tabStop
• tag
• text
• textDecoration
• textIndent
• textOrientation
• themeFont
• toHtml
• vAlign
• validator
• value
• visible
• watermark
• width
• wordWrap

构造方法

constructor

• new CellRange(sheet, row, col, rowCount?, colCount?, sheetArea?)

表单中的单元格区域

参数

属性名	类型	说明
sheet	Worksheet	包含此单元格区域的表单
row	number	单元格的行索引
col	number	单元格的列索引
rowCount?	number	-
colCount?	number	-
sheetArea?	SheetArea	-

属性

col

• col: number

获取起始列索引

---

colCount

• colCount: number

获取列数

---

row

• row: number

获取起始行索引

---

rowCount

• rowCount: number

获取行数

---

sheet

• sheet: Worksheet

获取包含此单元格区域的表单

---

sheetArea

• sheetArea: SheetArea

获取包含此单元格区域的区域

方法

altText

▸ altText(value?): any

获取或设置屏幕阅读器的单元格的替代文本

代码示例

var SpreadIcon = {
    FolderOpen: '\ue685',
    InfoFilled: '\ue718',
    Library: '\ue69d',
    NotebookFilled: '\uD800\uDC0F',
    Browse: '\ue626'
};
activeSheet.getCell(1, 1).value(SpreadIcon.FolderOpen).altText("Folder Open Icon");

// Besides plain text, the alternative text could also contain placeholder {value} or {formatted}, which represents cell value or cell formatted value.
// For example, if the cell value is 1000, and the alt text is "Sales amount is {value}", the final accessible content should be "Sales amount is 1000".
activeSheet.getCell(1, 1).value(1000).altText("Sales amount is {value}");

参数

属性名	类型	说明
value?	any	单元格的替代文本

返回值

any

如果未设置值，则返回单元格的替代文本；否则，返回单元格

---

backColor

▸ backColor(value?): any

获取或设置单元格的背景颜色，如"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"等

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backColor("pink");

参数

属性名	类型
value?	string | IGradientFill | IGradientPathFill | IPatternFill

返回值

any

如果没有设置值，返回单元格背景颜色；否则，返回单元格

---

backgroundImage

▸ backgroundImage(value?): any

获取或设置单元格的背景图像

代码示例

activeSheet.getCell(1,1).backgroundImage("images/example.jpg");

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回单元格背景图像；否则，返回单元格

---

backgroundImageLayout

▸ backgroundImageLayout(value?): any

获取或设置单元格的背景图像布局

代码示例

var layout = GC.Spread.Sheets.ImageLayout.stretch;
activeSheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).backgroundImageLayout(layout);

参数

属性名	类型
value?	ImageLayout

返回值

any

如果没有设置值，返回单元格背景图像布局；否则，返回单元格

---

bindingPath

▸ bindingPath(path?): any

获取或设置单元格绑定的绑定路径

代码示例

//本示例使用了bindingPath方法
var test = {name: "John"};
activeSheet.getCell(0,0).bindingPath( "name");
activeSheet.setDataSource(new GC.Spread.Sheets.Bindings.CellBindingSource(test));

参数

属性名	类型	说明
path?	string	单元格绑定的绑定路径

返回值

any

如果没有设置值，返回单元格绑定的绑定路径；否则，返回表单

---

borderBottom

▸ borderBottom(value?): any

获取或设置单元格的底边框

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderBottom(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));

参数

属性名	类型
value?	LineBorder

返回值

any

如果没有设置值，返回单元格底部边框线；否则，返回单元格

---

borderLeft

▸ borderLeft(value?): any

获取或设置单元格的左边框

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderLeft(new GC.Spread.Sheets.LineBorder("green", GC.Spread.Sheets.LineStyle.mediumDashed));

代码示例

activeSheet.getCell(1,1).borderLeft(new GC.Spread.Sheets.LineBorder("red", GC.Spread.Sheets.LineStyle.double));

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderLeft(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));

参数

属性名	类型
value?	LineBorder

返回值

any

如果没有设置值，返回单元格的左边框；否则，返回单元格

---

borderRight

▸ borderRight(value?): any

获取或设置单元格的右边框

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("green", GC.Spread.Sheets.LineStyle.mediumDashed));

代码示例

activeSheet.getCell(1,1).borderRight(new GC.Spread.Sheets.LineBorder("red", GC.Spread.Sheets.LineStyle.double));

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));

参数

属性名	类型
value?	LineBorder

返回值

any

如果没有设置值，返回单元格的右边框线；否则，返回单元格

---

borderTop

▸ borderTop(value?): any

获取或设置单元格的顶部边框

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderTop(new GC.Spread.Sheets.LineBorder("green", GC.Spread.Sheets.LineStyle.mediumDashed));

代码示例

activeSheet.getCell(1,1).borderTop(new GC.Spread.Sheets.LineBorder("red", GC.Spread.Sheets.LineStyle.double));

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderTop(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));

参数

属性名	类型
value?	LineBorder

返回值

any

如果没有设置值，返回单元格顶部边框线；否则，返回单元格

---

cellButtons

▸ cellButtons(value?): any

获取或设置单元格的单元格按钮

代码示例

activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).cellButtons([caption:"Text"]]);

代码示例

var cellButtons = activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).cellButtons();

参数

属性名	类型	说明
value?	ICellButton[]	单元格按钮

返回值

any

如果没有设置值，返回单元格按钮；否则，返回单元格

---

cellPadding

▸ cellPadding(value?): any

获取或设置单元格填充

代码示例

// 本示例在水印周围添加单元格填充
var type = new GC.Spread.Sheets.Style();
type.watermark = "User name";
type.cellPadding = "20";
type.labelOptions = {alignment:GC.Spread.Sheets.LabelAlignment.topLeft, visibility: GC.Spread.Sheets.LabelVisibility.visible};
activeSheet.setStyle(0, 1, type);
activeSheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);
activeSheet.getRange(-1, 1, -1, 1).width(150);
var combo = new GC.Spread.Sheets.CellTypes.ComboBox();
combo.items([{ text: "Oranges", value: "11k" }, { text: "Apples", value: "15k" }, { text: "Grape", value: "100k" }]);
combo.editorValueType(GC.Spread.Sheets.CellTypes.EditorValueType.text);
activeSheet.setCellType(2, 1, combo, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).watermark("ComboBox Cell Type").cellPadding('10 10 20 10');
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).labelOptions({alignment: GC.Spread.Sheets.LabelAlignment.bottomCenter, foreColor: 'yellowgreen', font: 'bold 15px Arial'});
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回单元格填充值；否则，返回单元格

---

cellType

▸ cellType(value?): any

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

代码示例

activeSheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).cellType(new GC.Spread.Sheets.CellTypes.CheckBox());

参数

属性名	类型
value?	Base

返回值

any

如果没有设置值，返回单元格类型；否则，返回单元格

---

clear

▸ clear(type): void

清除指定区域

参数

属性名	类型	说明
type	StorageType	清除类型

返回值

void

---

comment

▸ comment(value?): any

获取或设置单元格的批注

代码示例

// 本示例创建了一个单元格批注
var comment = new GC.Spread.Sheets.Comments.Comment();
comment.text("new comment!");
comment.backColor("yellow");
comment.foreColor("green");
comment.displayMode(GC.Spread.Sheets.Comments.DisplayMode.alwaysShown);
activeSheet.getCell(5,5).comment(comment);

参数

属性名	类型	说明
value?	Comment	在单元格中设置的批注

返回值

any

如果没有设置值，返回单元格中的批注；否则，返回单元格区域

---

defaultValue

▸ defaultValue(value?): any

获取或设置单元格的默认值

代码示例

activeSheet.getCell(1,1).defaultValue(10);
activeSheet.getCell(1,3).defaultValue("=LastYear+1000");

参数

属性名	类型
value?	any

返回值

any

如果没有设置值，则返回单元格默认值；否则，返回单元格

---

diagonalDown

▸ diagonalDown(value?): any

获取或设置单元格的对角线向下

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).diagonalDown(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));

参数

属性名	类型
value?	LineBorder

返回值

any

如果没有设置值，返回单元格对角线向下的线；否则，返回单元格

---

diagonalUp

▸ diagonalUp(value?): any

获取或设置单元格的对角线向上

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).diagonalUp(new GC.Spread.Sheets.LineBorder("blue", GC.Spread.Sheets.LineStyle.mediumDashed));

参数

属性名	类型
value?	LineBorder

返回值

any

如果没有设置值，返回单元格对角线向上行；否则，返回单元格

---

dropDowns

▸ dropDowns(value?): any

获取或设置单元格的下拉列表

代码示例

activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).dropDowns([caption:"Text"]]);

代码示例

var dropDowns = activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).dropDowns();

参数

属性名	类型
value?	IDropdown[]

返回值

any

如果没有设置值，返回单元格的下拉列表；否则，返回单元格

---

font

▸ font(value?): any

获取或设置单元格的字体，例如"normal normal normal 20px/normal Arial"

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).font("12pt Arial");

代码示例

activeSheet.getCell(1,1).font("8pt Arial");

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).font("12pt Arial");

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回单元格的字体；否则，返回单元格

---

fontFamily

▸ fontFamily(value?): any

获取或设置单元格的字体族，例如“Arial”。

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontFamily("Arial");

代码示例

activeSheet.getCell(1,1).fontFamily("Arial");

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontFamily("Arial");

参数

属性名	类型
value?	string

返回值

any

如果未设置值，则返回单元格的字体族；否则，返回单元格。

---

fontSize

▸ fontSize(value?): any

Gets or sets the fontSize for the cell, such as "16px".

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontSize("16px");

代码示例

activeSheet.getCell(1,1).fontSize("16px");

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontSize("16px");

参数

属性名	类型
value?	string

返回值

any

如果未设置值，返回单元格的字体大小；否则，返回单元格。

---

fontStyle

▸ fontStyle(value?): any

Gets or sets the fontStyle for the cell, such as "italic".

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontStyle("italic");

代码示例

activeSheet.getCell(1,1).fontStyle("italic");

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontStyle("italic");

参数

属性名	类型
value?	string

返回值

any

如果未设置值，则返回单元格的字体样式；否则，返回单元格。

---

fontWeight

▸ fontWeight(value?): any

Gets or sets the fontWeight for the cell, such as "bold".

代码示例

activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).fontWeight("bold");

代码示例

activeSheet.getCell(1,1).fontWeight("bold");

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).fontWeight("bold");

参数

属性名	类型
value?	string

返回值

any

如果未设置值，则返回单元格的字重设置；否则，返回单元格。

---

foreColor

▸ foreColor(value?): any

获取或设置单元格中的文本颜色，如"red"、"#FFFF00"、"rgb(255,0,0)"、"Accent 5"等

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).foreColor("blue");

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回单元格前景色；否则，返回单元格

---

formatter

▸ formatter(value?): any

获取或设置单元格的格式化

代码示例

activeSheet.getCell(1,1).formatter("0.000%");

代码示例

activeSheet.getCell(1, -1).formatter("0.000%");
activeSheet.getCell(1,0).value("2");

代码示例

activeSheet.getCell(-1, 0).formatter("0.000%");
activeSheet.getCell(0,0).value("2");

参数

属性名	类型
value?	string | GeneralFormatter

返回值

any

如果没有设置值，返回单元格格式化字符串或对象；否则，返回单元格

---

formula

▸ formula(value?): any

获取或设置单元格的公式

代码示例

activeSheet.getCell(0,2).formula("DATEDIF(DATE(2003,1,1),DATE(2016,1,1),\"Y\")");

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回单元格公式；否则，返回单元格

---

hAlign

▸ hAlign(value?): any

获取或设置单元格内容的水平对齐方式

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).hAlign(GC.Spread.Sheets.HorizontalAlign.right);

参数

属性名	类型
value?	HorizontalAlign

返回值

any

如果没有设置值，则返回单元格内容的水平对齐；否则，返回单元格

---

height

▸ height(value?): any

获取或设置行的高度(以像素为单位)

代码示例

activeSheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(90);

参数

属性名	类型
value?	number

返回值

any

如果没有设置值，返回行高；否则，返回行

---

imeMode

▸ imeMode(value?): any

获取或设置单元格的imeMode

代码示例

activeSheet.getCell(0, 0).imeMode(GC.Spread.Sheets.ImeMode.disabled);
//or
var style = new GC.Spread.Sheets.Style();
style.imeMode = GC.Spread.Sheets.ImeMode.disabled;
activeSheet.setStyle(0, 0, style);

代码示例

activeSheet.getRange(2, -1, 1, -1).imeMode(GC.Spread.Sheets.ImeMode.active);

代码示例

activeSheet.getRange(-1, 2, -1, 1).imeMode(GC.Spread.Sheets.ImeMode.auto);

参数

属性名	类型
value?	ImeMode

返回值

any

如果没有设置值，返回单元格imeMode;否则，返回单元格

---

isVerticalText

▸ isVerticalText(value?): any

获取或设置单元格的文本是否垂直

代码示例

activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).isVerticalText(false);
activeSheet.setText(2,0,"This is a test");

代码示例

activeSheet.getCell(1,1).isVerticalText(true);

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).isVerticalText(true);

参数

属性名	类型
value?	boolean

返回值

any

如果没有设置值，则返回单元格的文本是否垂直； 否则，返回单元格

---

labelOptions

▸ labelOptions(value?): any

获取或设置单元格标签选项

代码示例

//本示例为水印设置标签选项
var type = new GC.Spread.Sheets.Style();
type.watermark = "User name";
type.cellPadding = "20";
type.labelOptions = {alignment:GC.Spread.Sheets.LabelAlignment.topLeft, visibility: GC.Spread.Sheets.LabelVisibility.visible};
activeSheet.setStyle(0, 1, type);
activeSheet.getRange(0, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);
activeSheet.getRange(-1, 1, -1, 1).width(150);
var combo = new GC.Spread.Sheets.CellTypes.ComboBox();
combo.items([{ text: "Oranges", value: "11k" }, { text: "Apples", value: "15k" }, { text: "Grape", value: "100k" }]);
combo.editorValueType(GC.Spread.Sheets.CellTypes.EditorValueType.text);
activeSheet.setCellType(2, 1, combo, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).watermark("ComboBox Cell Type").cellPadding('10 10 20 10');
activeSheet.getCell(2, 1, GC.Spread.Sheets.SheetArea.viewport).labelOptions({alignment: GC.Spread.Sheets.LabelAlignment.bottomCenter, foreColor: 'yellowgreen', font: 'bold 15px Arial'});
activeSheet.getRange(2, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).height(60);

参数

属性名	类型
value?	ILabelOptions

返回值

any

如果未设置值，则返回单元格标签选项的值；否则，返回单元格

---

locked

▸ locked(value?): any

获取或设置单元格是否锁定当表单受到保护时，无法编辑锁定的单元格

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).locked(true);

参数

属性名	类型
value?	boolean

返回值

any

如果没有设置值，返回单元格是否被锁定；否则，返回单元格

---

mask

▸ mask(value?): any

获取或设置单元格的掩码。

代码示例

//This example sets mask of the cell.
var style = new GC.Spread.Sheets.Style();
var pattern = "[a0_]{8}";
style.pattern = pattern;
activeSheet.setStyle(0, 1, style);
activeSheet.getCell(0, 1, GC.Spread.Sheets.SheetArea.viewport).mask({ pattern: pattern});

参数

属性名	类型
value?	IMaskType

返回值

any

If no value is set, returns the value of the cell mask; otherwise, returns the cell.

---

quotePrefix

▸ quotePrefix(value?): any

获取或设置单元格的引号前缀

代码示例

activeSheet.getCell(1,1).quotePrefix(true);

参数

属性名	类型
value?	boolean

返回值

any

如果没有设置值，返回引号前缀的内容；否则，返回单元格

---

resizable

▸ resizable(value?): any

获取或设置用户是否可以调整行或列的大小

代码示例

activeSheet.getRange(-1, 3, -1, 1. GC.Spread.Sheets.SheetArea.viewport).resizable(true);

参数

属性名	类型
value?	boolean

返回值

any

如果没有设置值，返回用户是否可以调整行大小；否则，返回行或列

---

setBorder

▸ setBorder(border, option): void

设置区域的边框

代码示例

//本示例创建了边框
sheet.getCell(1, 1).borderTop(new GC.Spread.Sheets.LineBorder("#F0F8FF",GC.Spread.Sheets.LineStyle.double));
sheet.getCell(1, 1).borderLeft(new GC.Spread.Sheets.LineBorder("#F0F8FF",GC.Spread.Sheets.LineStyle.hair));
sheet.getCell(1, 1).borderRight(new GC.Spread.Sheets.LineBorder("#FAEBD7",GC.Spread.Sheets.LineStyle.dashDot));
sheet.getCell(1, 1).borderBottom(new GC.Spread.Sheets.LineBorder("#00FFFF",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderTop(new GC.Spread.Sheets.LineBorder("#F0FFFF",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderLeft(new GC.Spread.Sheets.LineBorder("#F5F5DC",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("#FF02FF", GC.Spread.Sheets.LineStyle.dashDot));
sheet.getRange(-1, 5, -1, 1, GC.Spread.Sheets.SheetArea.viewport).borderBottom (new GC.Spread.Sheets.LineBorder("#FFE4C4",GC.Spread.Sheets.LineStyle.thin));
sheet.getRange(2, 2, 2, 2, GC.Spread.Sheets.SheetArea.viewport).setBorder(new GC.Spread.Sheets.LineBorder("#8A2BE2",GC.Spread.Sheets.LineStyle.thick), { all:true });
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderTop( new GC.Spread.Sheets.LineBorder("#A52A2A",GC.Spread.Sheets.LineStyle.mediumDashed));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderLeft( new GC.Spread.Sheets.LineBorder("#FF02FF",GC.Spread.Sheets.LineStyle.medium));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderRight(new GC.Spread.Sheets.LineBorder("#5F9EA0", GC.Spread.Sheets.LineStyle.dashDot));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).borderBottom(new GC.Spread.Sheets.LineBorder("#6495ED",GC.Spread.Sheets.LineStyle.dotted));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).diagonalUp(new GC.Spread.Sheets.LineBorder("#FF02FF",GC.Spread.Sheets.LineStyle.dotted));
sheet.getRange(5, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).diagonalDown(new GC.Spread.Sheets.LineBorder("#6495ED",GC.Spread.Sheets.LineStyle.medium));

参数

属性名	类型	说明
border	LineBorder	边框线
option	ISetBorderOptions	确定选项对象包含要设置的单元格区域的哪一部分 {all:true, left:true, top:true, right:true, bottom:true, diagonalUp:true, diagonalDown:true, outline:true,inside:true, innerHorizontal:true, innerVertical:true}

返回值

void

---

setStyle

▸ setStyle(value): void

设置单元格的样式

代码示例

let style = new GC.Spread.Sheets.Style();
style.formatter = "#,##0.00";
sheet.getRange("E5:F10").setStyle(style);
sheet.getRange(0,0,4,4).setStyle(style);

参数

属性名	类型	说明
value	Style	样式

返回值

void

---

setStyleName

▸ setStyleName(value): void

设置单元格的命名样式

代码示例

let style = new GC.Spread.Sheets.Style();
style.name = "bold_style";
style.font = "bold 12px sans-serif";
sheet.addNamedStyle(style);
sheet.getRange("A1:D3").setStyleName("bold_style");
sheet.getRange(5,5,10,10).setStyleName("bold_style");

参数

属性名	类型	说明
value	string	样式名称

返回值

void

---

showEllipsis

▸ showEllipsis(value?): any

获取或设置单元格省略符属性

代码示例

activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).showEllipsis(false);
activeSheet.setText(2,0,"This is a test");

代码示例

activeSheet.getCell(1,1).showEllipsis(true);

参数

属性名	类型
value?	boolean

返回值

any

如果未设置值，则返回单元格省略符属性

---

shrinkToFit

▸ shrinkToFit(value?): any

获取或设置单元格是否缩小文本以适应单元格大小

代码示例

activeSheet.getRange(2,-1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).shrinkToFit(false);
activeSheet.setText(2,0,"This is a test");

代码示例

activeSheet.getCell(1,1).shrinkToFit(true);

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).shrinkToFit(true);

参数

属性名	类型
value?	boolean

返回值

any

如果未设置值，则返回单元格是否缩小文本以适应；否则，返回单元格

---

tabStop

▸ tabStop(value?): any

获取或设置一个值，该值指示用户是否可以使用Tab键设置单元格的焦点

代码示例

activeSheet.getCell(1,1).tabStop(false);
activeSheet.getRange(1, -1, 1, -1, GC.Spread.Sheets.SheetArea.viewport).tabStop(false);
activeSheet.getRange(-1, 1, -1, 1, GC.Spread.Sheets.SheetArea.viewport).tabStop(false);

参数

属性名	类型
value?	boolean

返回值

any

如果没有设置值，返回用户是否可以使用Tab键设置单元格的焦点；否则，返回单元格

---

tag

▸ tag(value?): any

获取或设置单元格的标签

代码示例

activeSheet.getCell(1,1).tag("cell tag");

参数

属性名	类型
value?	any

返回值

any

如果没有设置值，返回标签值；否则，返回单元格

---

text

▸ text(value?): any

获取或设置单元格的格式化文本

代码示例

activeSheet.getCell(1,1).text("cell object");

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回单元格文本；否则，返回单元格

---

textDecoration

▸ textDecoration(value?): any

获取或设置添加到单元格文本的修饰的类型

代码示例

activeSheet.getRange(1, -1, 1, -1).textDecoration(GC.Spread.Sheets.TextDecorationType.overline | GC.Spread.Sheets.TextDecorationType.underline);

参数

属性名	类型
value?	TextDecorationType

返回值

any

如果没有设置值，返回修饰的类型；否则，返回单元格

---

textIndent

▸ textIndent(value?): any

获取或设置单元格的文本缩进

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).textIndent(1);

参数

属性名	类型
value?	number

返回值

any

如果没有设置值，返回单元格文本缩进；否则，返回单元格

---

textOrientation

▸ textOrientation(value?): any

获取或设置单元格的文本旋转角度

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).textOrientation(66);

参数

属性名	类型
value?	number

返回值

any

如果没有设置值，返回单元格文本的旋转角度；否则，返回单元格

---

themeFont

▸ themeFont(value?): any

获取或设置单元格的主题字体

代码示例

activeSheet.getCell(-1, 0).themeFont("Body");
activeSheet.getCell(0,0).value("Test");

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回单元格的主题字体；否则，返回单元格

---

toHtml

▸ toHtml(headerOptions?, includeStyle?): string

从指定区域获取HTML内容

代码示例

activeSheet.getRange(0, 0, 10, 10).toHtml();

参数

属性名	类型
headerOptions?	HeaderOptions
includeStyle?	boolean

返回值

string

包含单元格文本、单元格合并和单元格样式的HTML内容

---

vAlign

▸ vAlign(value?): any

获取或设置单元格内容的垂直对齐方式

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).vAlign(GC.Spread.Sheets.VerticalAlign.top);

参数

属性名	类型
value?	VerticalAlign

返回值

any

如果没有设置值，则返回单元格内容的垂直对齐方式；否则，返回单元格

---

validator

▸ validator(value?): any

获取或设置单元格的数据验证

代码示例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createDateValidator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between, new Date(2012, 11, 31), new Date(2013, 11, 31));
dv.showInputMessage(true);
dv.inputMessage("Enter a date between 12/31/2012 and 12/31/2013.");
dv.inputTitle("Tip");
activeSheet.getCell(0,0).validator(dv);

代码示例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createDateValidator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between, new Date(2012, 11, 31), new Date(2013, 11, 31));
dv.showInputMessage(true);
dv.inputMessage("Enter a date between 12/31/2012 and 12/31/2013.");
dv.inputTitle("Tip");
activeSheet.getCell(1, -1).validator(dv);

代码示例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(-1,0,dv);

参数

属性名	类型	说明
value?	DefaultDataValidator	单元格数据验证

返回值

any

如果没有设置值，返回单元格数据验证；否则，返回单元格

---

value

▸ value(value?): any

获取或设置单元格的未格式化值

代码示例

activeSheet.getCell(1,1).value(10);

参数

属性名	类型
value?	any

返回值

any

如果没有设置值，返回单元格值；否则，返回单元格

---

visible

▸ visible(value?): any

获取或设置是否显示行或列

代码示例

activeSheet.getCell(-1, 0).visible(false);

参数

属性名	类型
value?	boolean

返回值

any

如果没有设置值，返回行或列的可见值；否则，返回行或列

---

watermark

▸ watermark(value?): any

获取或设置单元格水印的内容

代码示例

activeSheet.getCell(1,1).watermark("lightgreen");

参数

属性名	类型
value?	string

返回值

any

如果没有设置值，返回水印的内容；否则，返回单元格

---

width

▸ width(value?): any

获取或设置列的宽度(以像素为单位)

代码示例

activeSheet.getCell(-1, 0).width(20);

参数

属性名	类型
value?	number

返回值

any

如果没有设置值，返回列宽度；否则，返回列

---

wordWrap

▸ wordWrap(value?): any

获取或设置单元格是否允许文本换行

代码示例

activeSheet.getRange(-1, 3, -1, 1, GC.Spread.Sheets.SheetArea.viewport).wordWrap(true);

参数

属性名	类型
value?	boolean

返回值

any

如果没有设置值，返回单元格是否允许文本换行；否则，返回单元格