Excel.Worksheet class
Excel 工作表是由单元格组成的网格。 它可以包含数据、表、图表等。若要了解有关工作表对象模型的详细信息，请阅读 使用 Excel JavaScript API 处理工作表。
- Extends
注解
属性
| charts | 返回属于工作表的图表集合。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 返回用于唯一标识指定工作簿中工作表的值。 即使工作表被重命名或移动，标识符的值仍然相同。 |
| name | 工作表的显示名称。 |
| pivot |
一组属于工作表的数据透视表对象。 |
| position | 工作表在工作簿中的位置，从零开始。 |
| protection | 返回工作表的工作表保护对象。 |
| tables | 属于工作表的表的集合。 |
| visibility | 工作表的可见性。 |
方法
| activate() | 在 Excel UI 中激活工作表。 |
| delete() | 从工作簿中删除工作表。 请注意，如果工作表的可见性设置为“VeryHidden”，则删除操作将失败并出现 |
| get |
|
| get |
|
| get |
使用的区域是包含分配了值或格式化的任何单元格的最小区域。 如果整个工作表为空，此函数将返回左上角的单元格 (即 不会) 引发错误。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
charts
返回属于工作表的图表集合。
readonly charts: Excel.ChartCollection;属性值
注解
context
id
返回用于唯一标识指定工作簿中工作表的值。 即使工作表被重命名或移动，标识符的值仍然相同。
readonly id: string;属性值
string
注解
name
pivotTables
一组属于工作表的数据透视表对象。
readonly pivotTables: Excel.PivotTableCollection;属性值
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml
await Excel.run(async (context) => {
// Get the names of all the PivotTables in the current worksheet.
const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the current worksheet:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
position
工作表在工作簿中的位置，从零开始。
position: number;属性值
number
注解
示例
// Set worksheet position.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.position = 2;
await context.sync();
});
protection
返回工作表的工作表保护对象。
readonly protection: Excel.WorksheetProtection;属性值
注解
示例
// Unprotecting a worksheet with unprotect() will remove all
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
sheet.protection.protect({
allowInsertRows: false, // Protect row insertion
allowDeleteRows: true // Unprotect row deletion
});
});
tables
属于工作表的表的集合。
readonly tables: Excel.TableCollection;属性值
注解
visibility
工作表的可见性。
visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";属性值
Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"
注解
方法详细信息
activate()
在 Excel UI 中激活工作表。
activate(): void;返回
void
注解
示例
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.activate();
await context.sync();
});
delete()
从工作簿中删除工作表。 请注意，如果工作表的可见性设置为“VeryHidden”，则删除操作将失败并出现 InvalidOperation 异常。 删除之前，应首先将其可见性更改为隐藏或可见。
delete(): void;返回
void
注解
示例
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.delete();
await context.sync();
});
getCell(row, column)
Range获取包含基于行号和列号的单个单元格的对象。 单元格可以位于其父区域的边界之外，只要它保留在工作表网格中。
getCell(row: number, column: number): Excel.Range;参数
- row
-
number
要检索的单元格的行号。 从零开始编制索引。
- column
-
number
要检索的单元格的列号。 从零开始编制索引。
返回
注解
示例
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const cell = worksheet.getCell(0,0);
cell.load('address');
await context.sync();
console.log(cell.address);
});
getRange(address)
Range获取 对象，该对象表示由地址或名称指定的单个矩形单元格块。
getRange(address?: string): Excel.Range;参数
- address
-
string
可选。 表示范围地址或名称的字符串。 例如，“A1：B2”。 如果未指定，则返回整个工作表区域。
返回
注解
示例
// Use the range address to get the range object.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
getUsedRange(valuesOnly)
使用的区域是包含分配了值或格式化的任何单元格的最小区域。 如果整个工作表为空，此函数将返回左上角的单元格 (即 不会) 引发错误。
getUsedRange(valuesOnly?: boolean): Excel.Range;参数
- valuesOnly
-
boolean
可选。 如果 true为 ，则仅将值视为已用单元格的单元格， (忽略格式设置) 。 [Api 集：ExcelApi 1.2]
返回
注解
示例
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
const usedRange = worksheet.getUsedRange();
usedRange.load('address');
await context.sync();
console.log(usedRange.address);
});
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.Worksheet;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
示例
// Get worksheet properties based on sheet name.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.load('position')
await context.sync();
console.log(worksheet.position);
});
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Worksheet;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.WorksheetUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
示例
// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
const activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.set({
tabColor: "yellow",
name: "MySheet"
});
await context.sync();
});
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Excel.Worksheet): void;参数
- properties
- Excel.Worksheet
返回
void
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.Worksheet 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.WorksheetData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.WorksheetData;返回
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈