- GC.Data
- GC.Pivot
- GC.Spread.Pivot
- GC.Spread.Slicers
- GC.Spread.CalcEngine
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Report
- GC.Spread.Sheets
- GC.Spread.Sheets.IO
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.FormulaPanel
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.GanttSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Sheets.Designer
- GC.Spread.Excel.IO
GC.Spread.Sheets.Outlines.Outline
类: Outline
Table of contents
构造方法
方法
- direction
- expand
- expandGroup
- find
- getCollapsed
- getLevel
- getMaxLevel
- getState
- group
- isCollapsed
- isGroupEnd
- refresh
- resumeAdding
- setCollapsed
- suspendAdding
- ungroup
- ungroupRange
构造方法
constructor
• new Outline(count)
表单的区域分组
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
count |
number |
行数或列数 |
方法
direction
▸ direction(direction?): any
获取或设置区域分组的方向
代码示例
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(3,2);
activeSheet.columnOutlines.group(4,1);
activeSheet.rowOutlines.direction(GC.Spread.Sheets.Outlines.OutlineDirection.forward);
activeSheet.resumePaint();
参数
| 属性名 | 类型 |
|---|---|
direction? |
OutlineDirection |
返回值
any
如果未设置任何值，则返回区域分组的方向；否则，返回区域分组
expand
▸ expand(level, expand): void
展开指定的级别所有区域分组
代码示例
//本示例使用expand方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,false);
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
level |
number |
区域分组的扩大或折叠的级别 |
expand |
boolean |
是否扩展组 |
返回值
void
expandGroup
▸ expandGroup(groupInfo, expand): void
展开或折叠行或列的指定区域分组
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
groupInfo |
OutlineInfo |
区域分组的组信息 |
expand |
boolean |
是否扩展组 |
返回值
void
find
▸ find(index, level): OutlineInfo
获取具有指定组级别和行或列索引的区域分组
代码示例
//本示例使用find方法
activeSheet.rowOutlines.group(0,5);
var rgi = activeSheet.rowOutlines.find(1, 0);
rgi.state(GC.Spread.Sheets.Outlines.OutlineState.collapsed);
spread.invalidateLayout();
spread.repaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
行或列的索引 |
level |
number |
区域分组的级别 |
返回值
区域分组
getCollapsed
▸ getCollapsed(index): boolean
获取折叠的内部
代码示例
//本示例使用getCollapsed方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,true);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.isCollapsed(0));
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
索引 |
返回值
boolean
如果折叠，返回true;否则返回false
getLevel
▸ getLevel(index): number
获取指定行或列的级别 级别的索引从零开始
代码示例
//本示例使用getLevel方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,true);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.getLevel(0));
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
行或列的索引 |
返回值
number
行或列的级别
getMaxLevel
▸ getMaxLevel(): number
获取最深级别的编号
remarks 级别的索引从零开始
代码示例
//本示例使用getMaxLevel方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.group(1,4);
activeSheet.rowOutlines.expand(0,true);
activeSheet.columnOutlines.group(0,1);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.getMaxLevel());
返回值
number
深级别的编号
getState
▸ getState(groupInfo): OutlineState
获取指定组的状态
代码示例
//本示例使用getState方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
var rgi = activeSheet.rowOutlines.find(1, 0);
rgi.state(GC.Spread.Sheets.Outlines.OutlineInfo.collapsed);
alert(activeSheet.rowOutlines.getState(rgi));
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
groupInfo |
OutlineInfo |
组信息 |
返回值
组状态
group
▸ group(index, count): void
从指定的起始索引将行或列的区域分组为区域分组
代码示例
//本示例使用group方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,false);
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
组起始索引 |
count |
number |
要分组的行数或列数 |
返回值
void
isCollapsed
▸ isCollapsed(index): boolean
确定指定索引处的区域分组是否折叠
代码示例
//本示例使用isCollapsed方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.expand(0,true);
activeSheet.resumePaint();
alert(activeSheet.rowOutlines.isCollapsed(0));
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
区域分组中行或列的索引 |
返回值
boolean
如果指定的行或列折叠，返回true;否则返回false
isGroupEnd
▸ isGroupEnd(index, processLevel): boolean
确定指定的索引是否在组的末尾
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
索引 |
processLevel |
number |
流程级别 |
返回值
boolean
如果指定的索引在组的末尾，返回true;否则返回false
refresh
▸ refresh(): void
刷新此区域分组
返回值
void
resumeAdding
▸ resumeAdding(): void
恢复添加
返回值
void
setCollapsed
▸ setCollapsed(index, collapsed): void
设置折叠级别
代码示例
//本示例使用setCollapsed方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.setCollapsed(0,false);
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
索引 |
collapsed |
boolean |
设置为true来折叠级别 |
返回值
void
suspendAdding
▸ suspendAdding(): void
暂停添加
返回值
void
ungroup
▸ ungroup(): void
删除所有区域分组
代码示例
//本示例使用ungroup方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.ungroup();
activeSheet.resumePaint();
返回值
void
ungroupRange
▸ ungroupRange(index, count): void
从指定的起始索引处的区域分组中删除一定区域的行或列
代码示例
//本示例使用ungroupRange方法
activeSheet.suspendPaint();
activeSheet.rowOutlines.group(0,5);
activeSheet.rowOutlines.ungroupRange(0,1);
activeSheet.resumePaint();
参数
| 属性名 | 类型 | 说明 |
|---|---|---|
index |
number |
组起始索引 |
count |
number |
要删除的行数或列数 |
返回值
void