备案控制台
文档
产品文档
输入文档关键字查找
首页 智能媒体管理 操作指南 文档处理 WebOffice前端开发 高级用法 表格 活动工作表

活动工作表

更新时间：
一键部署
提交缺陷
产品详情
相关技术圈
我的收藏

本文介绍使用表格文档时如何获取可编辑区域对象、保护工作表、设置工作表是否可见等。

获取活动工作表对象

获取活动工作簿中的活动工作表。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;
}

可编辑区域

获取可编辑区域对象

获取活动工作簿中活动工作表的可编辑区域。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取可编辑区域对象
  const allowEditRanges = await activeSheet.AllowEditRanges;
}

添加可编辑区域

在受保护的工作表（Sheet）中添加一个可编辑区域。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Add({ Title, Range, Password })

    表达式：文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Range

    Object

    是

    区域对象。

    Title

    String

    否

    标题。

    Password

    String

    否

    密码。

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;

  //设置范围：左上角至A1，右下角至E20
  const range = await activeSheet.Range('$A1:$E20');

  //添加可编辑区域
  await allowEditRanges.Add(undefined, range, 'WebOffice');
}

获取可编辑区域数量

受保护的工作表（Sheet）中可编辑区域的数量

  • 语法

    表达式ActiveWorkbook.ActiveSheet.AllowEditRanges.Count

  • 示例

    async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  
  // 可编辑区域数量
  const count = await allowEditRanges.Count;
}

获取可编辑区域元素

获取可编辑区域

受保护的工作表（Sheet）中可编辑区域的元素

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index)

    表达式：文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    说明

    Index

    Variant

    是

    对象的索引

  • 示例

    async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  const item = await allowEditRanges.Item(1);
}

删除可编辑区域

删除受保护的工作表（Sheet）中可编辑区域的元素

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Delete()

    表达式：文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    说明

    Password

    Variant

    是

    保护工作表的密码

  • 示例

    async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  const item = await allowEditRanges.Item(1);
  await item.Delete('123');
}

可编辑区域选区

受保护的工作表（Sheet）中可编辑区域的元素的选区

  • 语法

表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Range

表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  const item = await allowEditRanges.Item(1);
  await item.Range;
}

可编辑区域用户组

受保护的工作表（Sheet）中可编辑区域的元素的选区

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Users

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  const item = await allowEditRanges.Item(1);
  // 可编辑区域用户组
  await item.Users;
}

可编辑区域增加用户

受保护的工作表（Sheet）中可编辑区域元素增加用户

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).AddUser()

    表达式：文档类型应用对象

  • 参数

属性

数据类型

是否必填

说明

Password

Variant

是

保护工作表的密码

UserId

Variant

是

用户ID

  • 示例

    async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  const item = await allowEditRanges.Item(1);

  //增加用户
  await item.AddUser({Password:'', UserId:'280289376'});
}

可编辑区域移除用户

受保护的工作表（Sheet）中可编辑区域元素移除用户

  • 语法

表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).RemoveUser()

表达式：文档类型应用对象

  • 参数

属性

数据类型

是否必填

说明

Password

Variant

是

保护工作表的密码

UserId

Variant

是

用户ID

  • 示例

    async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  const item = await allowEditRanges.Item(1);
  // 移除用户
  await item.RemoveUser({Password:'', UserId:'280289376'});
}

获取图表对象

获取工作表上的所有图表对象。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.ChartObjects

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取工作表上的所有图表
  const chartObjects = await activeSheet.ChartObjects;
}

获取行

获取工作表上的所有行，返回的是一个Range对象。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Rows

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取工作表上的所有行
  const chartObjects = await activeSheet.Rows;
}

获取列

获取工作表上的所有列，返回的是一个Range对象。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Columns

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取工作表上的所有列
  const chartObjects = await activeSheet.Columns;
}

获取单元格

获取工作表上的所有单元格，返回的是一个Range对象。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Cells

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取工作表上的所有单元格
  const cells = await activeSheet.Cells;
}

删除工作表

删除活动工作簿中的活动工作表。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Delete()

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //删除工作表
  await activeSheet.Delete();
}

获取索引号

获取工作表对应的索引号。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Index

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取工作表对应索引号
  const index = await activeSheet.Index;
  console.log(index);
}

获取工作表名称

返回一个Names集合，该集合代表所有工作表特定的名称。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Names

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //返回一个Names集合，该集合代表所有工作表特定的名称
  const names = await activeSheet.Names;
}

保护工作表

保护工作表使其不被修改。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Protect({ Password, DrawingObjects, Scenarios, AllowFormattingCells, AllowFormattingColumns, AllowFormattingRows, AllowInsertingColumns, AllowInsertingRows, AllowInsertingHyperlinks, AllowDeletingColumns, AllowDeletingRows, AllowSorting, AllowFiltering, AllowUsingPivotTables })

    表达式：文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Password

    String

    否

    指定工作表或工作簿的密码。该密码字符串区分大小写。

    • 省略此参数，可以不使用密码解除对工作表或工作簿的保护。

    • 使用此参数，必须使用指定密码才能解除对工作表或工作簿的保护。

    重要

    请务必牢记设置的密码，如果忘记密码，则无法解除对工作表或工作簿的保护。

    DrawingObjects

    Boolean

    否

    是否保护工作表形状。取值范围如下：

    • false（默认）：否。

    • true：是。

    Scenarios

    Boolean

    否

    是否保护工作表方案，此参数仅对工作表有效。取值范围如下：

    • true（默认）：是。

    • false：否。

    AllowFormattingCells

    Boolean

    否

    是否允许用户格式化受保护工作表上的任何单元格。取值范围如下：

    • false（默认）：否。

    • true：是。

    AllowFormattingColumns

    Boolean

    否

    是否允许用户格式化受保护工作表上的任何列。取值范围如下：

    • false（默认）：否。

    • true：是。

    AllowFormattingRows

    Boolean

    否

    是否允许用户格式化受保护的工作表上的任何行。取值范围如下：

    • false（默认）：否。

    • true：是。

    AllowInsertingColumns

    Boolean

    否

    是否允许用户在受保护工作表上插入列。取值范围如下：

    • false（默认）：否。

    • true：是。

    AllowInsertingRows

    Boolean

    否

    是否允许用户在受保护工作表上插入行。取值范围如下：

    • false（默认）：否。

    • true：是。

    AllowInsertingHyperlinks

    Boolean

    否

    是否允许用户在受保护的工作表上插入超链接。取值范围如下：

    • false（默认）：否。

    • true：是。

    AllowDeletingColumns

    Boolean

    否

    是否允许用户在受保护的工作表上删除列。取值范围如下：

    • false（默认）：否。

    • true：是。要删除的列中的每个单元格都处于解锁状态。

    AllowDeletingRows

    Boolean

    否

    是否允许用户在受保护的工作表上删除行。取值范围如下：

    • false（默认）：否。

    • true：是。要删除的行中的每个单元格都处于解锁状态。

    AllowSorting

    Boolean

    否

    是否允许用户对受保护工作表进行排序。取值范围如下：

    • false（默认）：否。

    • true：是。排序范围内的每个单元格都必须处于解锁或不受保护的状态。

    AllowFiltering

    Boolean

    否

    是否允许用户在受保护的工作表上设置筛选。取值范围如下：

    • false（默认）：否。

    • true：是。用户可以在现有自动筛选上设置筛选或更改筛选条件，但无法启用或禁用自动筛选。

    AllowUsingPivotTables

    Boolean

    否

    是否允许用户在受保护的工作表上使用数据透视表。取值范围如下：

    • false（默认）：否。

    • true：是。

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //输入密码
  activeSheet.Protect('123456');
}

解除保护

解除工作表或工作簿中的保护。如果工作表或工作簿不受保护，则此方法无效。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Unprotect({ Password })

    表达式：文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Password

    String

    否

    设置的密码。

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //解除保护
  activeSheet.Unprotect('123456');
}

获取图形对象

获取当前工作表上的所有Shape对象的集合。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Shapes

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //获取当前工作表上的所有Shape对象的集合
  const shapes = await activeSheet.Shapes;
}

设置工作表是否可见

设置活动工作簿中的活动工作表是否可见。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Visible

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  //设置工作表不可见
  activeSheet.Visible = false;
}

获取所用区域对象

获取工作表上的所用区域，返回Range对象。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.UsedRange

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
  //工作表上的所用区域
  const UsedRange = await activeSheet.UsedRange;
}

获取区域对象

获取区域对象，返回一个Range对象，表示一个单元格或单元格区域。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.Range

    表达式：文档类型应用对象

  • 示例

    async function example() {
  await instance.ready();

  const app = instance.Application;
  
  //获取活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
  //获取区域对象，返回一个Range对象，它表示一个单元格或单元格区域
  const range = await activeSheet.Range;
}
文档推荐
  • 本页导读 （1）
文档反馈