与表格文档ActiveSheet相关的API_智能媒体管理(IMM)-阿里云帮助中心

本文介绍与表格文档ActiveSheet相关的API。

ActiveSheet

ActiveWorkbook.ActiveSheet

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

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveWorkbook.ActiveSheet
表达式：文档类型应用对象

示例

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

  const app = instance.Application;
  
  //获取活动工作簿
  const activeWorkbook = await app.ActiveWorkbook;

  //获取活动工作簿中的活动工作表
  const activeSheet = await activeWorkbook.ActiveSheet;
}

方法

ActiveWorkbook.ActiveSheet.Delete()

通过Delete()方法，您可以删除活动工作表。

语法
表达式.ActiveWorkbook.ActiveSheet.Delete()
表达式：文档类型应用对象

示例

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

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

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

ActiveWorkbook.ActiveSheet.ExportAsFixedFormat()

通过ExportAsFixedFormat()方法，您可以将当前活动工作表导出为对应的PDF或IMG图片，并获取导出文件的URL。

语法
表达式.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat({ Type })
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Type
Enum
可选
导出的文件类型，目前仅支持导出图片和PDF。更多信息，请参见XlFixedFormatType。
返回值
返回导出文件的URL。

示例

导出为PDF

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

  const app = instance.Application;

  //导出为PDF，并获取导出文件的URL
  const workbookPdfUrl = await app.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat();
  console.log(workbookPdfUrl);
}

导出为图片

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

  const app = instance.Application;

  //导出为图片，并获取导出文件的URL
  const workbookPdfUrl = await app.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat({
    Type: app.Enum.XlFixedFormatType.xlTypeIMG,
  });
  console.log(workbookPdfUrl);
}

ActiveWorkbook.ActiveSheet.Protect()

通过Protect()方法，您可以设置保护活动工作表使其不被修改。

语法
表达式.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()

通过Unprotect()方法，您可以解除活动工作表中的保护，如果活动工作表未受保护，则此方法无效。

语法
表达式.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');
}

ActiveWorkbook.ActiveSheet.Move()

通过Move()方法，您可以移动活动工作表。

重要

JS-SDK V1.1.12及以上版本支持此功能。

语法
表达式.ActiveWorkbook.ActiveSheet.Move({ Before, After })
表达式：文档类型应用对象

参数

属性	数据类型	是否必填	描述
Before	number	否	指定的活动工作表ID。将目标活动工作表移动到该活动工作表之前。如果指定Before，则不能指定After。
After	number	否	指定的活动工作表ID。将目标活动工作表移动到该活动工作表之后。如果指定After，则不能指定Before。

示例

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

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

  //将目标活动工作表移动到该活动工作表之后
  await app.ActiveWorkbook.Sheets(1).Move({
    Before: null,
    After: await app.ActiveWorkbook.Sheets(2).Id,
}

ActiveWorkbook.ResetClipBoard()

通过ResetClipBoard()方法，您可以清除复制蚂蚁线。

语法
表达式.ActiveWorkbook.ResetClipBoard({ Range })
表达式：文档类型应用对象

示例

//@file=base.xlsx
async function example() {
  await instance.ready();

  const app = instance.Application;
  const range = await app.Selection;
  //清除复制蚂蚁线
  await app.ActiveWorkbook.ResetClipBoard()
}

属性

ActiveWorkbook.ActiveSheet.Cells

通过Cells属性，您可以获取活动工作表中的所有单元格。

语法
表达式.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.Columns

通过Columns属性，您可以获取活动工作表中的所有列。

语法
表达式.ActiveWorkbook.ActiveSheet.Columns
表达式：文档类型应用对象

示例

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

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

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

ActiveWorkbook.ActiveSheet.Index

通过Index属性，您可以获取活动工作表对应的索引号。

语法
表达式.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);
}

ActiveWorkbook.ActiveSheet.Name

通过Name属性，您可以获取活动工作表对应的名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Name
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表对应的名称
  const name = await app.ActiveWorkbook.ActiveSheet.Name;
  console.log(name);
}

ActiveWorkbook.ActiveSheet.Names

通过Names属性，您可以获取活动工作表的所有特定名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所有特定名称
  const names = await activeSheet.Names;
}

ActiveWorkbook.ActiveSheet.Range

通过Range属性，您可以获取活动工作表中的一个单元格、一行、一列、一个包含单个或若干连续单元格区域的选定单元格范围。

语法
表达式.ActiveWorkbook.ActiveSheet.Range
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表中的一个单元格区域
  const range = await app.Range('A1');
}

ActiveWorkbook.ActiveSheet.Rows

通过Rows属性，您可以获取活动工作表中的所有行。

语法
表达式.ActiveWorkbook.ActiveSheet.Rows
表达式：文档类型应用对象

示例

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

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

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

ActiveWorkbook.ActiveSheet.Shapes

通过Shapes属性，您可以获取活动工作表中的所有图形对象。

语法
表达式.ActiveWorkbook.ActiveSheet.Shapes
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表中的所有图形对象
  const shapes = await activeSheet.Shapes;
}

ActiveWorkbook.ActiveSheet.Visible

通过Visible属性，您可以设置活动工作表是否可见。

语法
表达式.ActiveWorkbook.ActiveSheet.Visible
表达式：文档类型应用对象
Visible取值为true时，表示活动工作表可见，取值为false时，表示活动工作表不可见。

示例

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

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

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

ActiveWorkbook.ActiveSheet.UsedRange

通过UsedRange属性，您可以获取活动工作表中的所用区域。

语法
表达式.ActiveWorkbook.ActiveSheet.UsedRange
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所用区域
  const UsedRange = await activeSheet.UsedRange;
}

ActiveWorkbook.ActiveSheet.Type

通过Type属性，您可以获取活动工作表的类型。活动工作表包含xlWorksheet（普通工作表）、xlEtDataBaseSheet（空白数据表）和xlEtDashBoardSheet（仪表板）三种类型。

语法
表达式.ActiveWorkbook.ActiveSheet.Type
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的类型
  const type = await activeSheet.Type;
  console.log(type);
}

ActiveWorkbook.ActiveSheet.Id

通过Id属性，您可以获取活动工作表的编号。

语法
表达式.ActiveWorkbook.ActiveSheet.Id
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的编号
  const id = await activeSheet.Id;
  console.log(id);
}

ActiveWorkbook.ActiveSheet.ChartObjects

通过ChartObjects属性，您可以获取工作表上的所有图表。

语法
表达式.ActiveWorkbook.ActiveSheet.ChartObjects
表达式：文档类型应用对象

示例

//@file=base.xlsx
async function example() {
  await instance.ready();

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

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

AllowEditRanges

ActiveWorkbook.ActiveSheet.AllowEditRanges

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

语法
表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
}

方法

ActiveWorkbook.ActiveSheet.AllowEditRanges.Add()

通过Add()方法，您可以在活动工作表中添加一个可编辑区域。

语法
表达式.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, 'Aliyun');
}

Names

ActiveWorkbook.ActiveSheet.Names

获取活动工作表的所有名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;
}

方法

ActiveWorkbook.ActiveSheet.Names.Add()

通过Add()方法，您可以为指定单元格定义新名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Add({ Name, RefersTo })
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Name
String
是
新名称。
RefersTo
Number
否
需要定义新名称的单元格。

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //为A1单元格定义一个新名称
  names.Add('新表', 'A1');
}

ActiveWorkbook.ActiveSheet.Names.ValidNewName()

通过ValidNewName()方法，您可以检查指定名称是否合法。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.ValidNewName({ Name })
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Name
String
是
名称。

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //检查名称是否合法
  names.ValidNewName('新表');
}

属性

ActiveWorkbook.ActiveSheet.Names.Count

通过Count属性，您可以获取活动工作表中的名称数量。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Count
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //获取名称数量
  const count = await names.Count;
  console.log(count);
}

Name

ActiveWorkbook.ActiveSheet.Names.Item(Index)

获取活动工作表中的单个名称对象。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index)
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //获取单个名称对象
  const name = await names.Item(1);
}

方法

ActiveWorkbook.ActiveSheet.Names.Item(Index).Delete()

通过Delete()方法，您可以删除活动工作表中的单个名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Delete()
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //获取单个名称对象
  const name = await names.Item(1);

  //删除该名称
  await name.Delete();
}

属性

ActiveWorkbook.ActiveSheet.Names.Item(Index).Name

通过Name属性，您可以获取单个名称对象的具体名称。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Name
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //获取单个名称对象
  const name = await names.Item(1);

  //获取具体名称
  const nameName = await name.Name;
  console.log(nameName);
}

ActiveWorkbook.ActiveSheet.Names.Item(Index).Value

通过Value属性，您可以获取单个名称对象的值。

语法
表达式.ActiveWorkbook.ActiveSheet.Names.Item(Index).Value
表达式：文档类型应用对象

示例

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

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

  //获取活动工作表的所有名称
  const names = await activeSheet.Names;

  //获取单个名称对象
  const name = await names.Item(1);

  //获取名称的值
  const value = await name.Value;
  console.log(value);
}

属性	数据类型	是否必填	描述
Type	Enum	可选	导出的文件类型，目前仅支持导出图片和PDF。更多信息，请参见XlFixedFormatType。