使用 Excel JavaScript API 获取范围

  • 项目

本文提供了一些示例，这些示例演示了使用 Excel JavaScript API 获取工作表中的区域的不同方法。 有关对象支持的属性和方法 Range 的完整列表，请参阅 Excel.Range 类。

注意

The Excel JavaScript API 没有“Cell”对象或类。 相反，Excel JavaScript API 将所有 Excel 单元格定义为 Range 对象。 Excel UI 中的单个单元格转换为 Excel JavaScript API 中包含一个单元格的 Range 对象。 单个 Range 对象也可以包含多个连续的单元格。 若要了解详细信息，请参阅使用 Excel JavaScript API 处理单元格。

按地址获取区域

下面的代码示例从名为 Sample 的工作表中获取地址为 B2：C5 的区域，加载其address属性，并将消息写入控制台。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    
    let range = sheet.getRange("B2:C5");
    range.load("address");
    await context.sync();
    
    console.log(`The address of the range B2:C5 is "${range.address}"`);
});

按名称获取区域

下面的代码示例从名为 Sample 的工作表中获取名为 MyRange的区域，加载其 address 属性，并将消息写入控制台。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange("MyRange");
    range.load("address");
    await context.sync();

    console.log(`The address of the range "MyRange" is "${range.address}"`);
});

获取使用的区域

下面的代码示例从名为 Sample 的工作表中获取已用区域，加载其 address 属性，并将消息写入控制台。 使用的区域是包含工作表中分配了值或格式的任意单元格的最小区域。 如果整个工作表为空，该方法 getUsedRange() 将返回一个仅包含左上角单元格的区域。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getUsedRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the used range in the worksheet is "${range.address}"`);
});

获取整个区域

下面的代码示例从名为 Sample 的工作表中获取整个工作表区域，加载其 address 属性，并将消息写入控制台。

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");

    let range = sheet.getRange();
    range.load("address");
    await context.sync();
    
    console.log(`The address of the entire worksheet range is "${range.address}"`);
});

另请参阅