如何在 Excel 工作表中使用 Office-js 插入页眉和页脚

Question

我们想使用 Office-js Api 将文本插入到 Excel 工作表的页眉和页脚中。现在或在不久的将来有什么方法可以做到这一点吗？

Answer 1

此功能在ExcelApi 1.9（今年5月）中引入。 文档

一些示例代码：

Excel.run(async (context)=>{
  const sheets = context.workbook.worksheets;
  sheets.load({$all: true}); // Load all sheets

  const headerFooter = sheets.getActiveWorksheet().pageLayout.headersFooters.defaultForAllPages;
  headerFooter.load({$all: true}); // Load header/footer

  await context.sync();

  headerFooter.set({leftHeader: 'something'});
});

Answer 2

虽然@RoelVB 代码确实有帮助，但我也发现它很混乱。 其一，无需加载那么多选项。

事实上，我只在遍历每个工作表时才加载属性。 如果我在特定工作表上设置，则不需要。 而且，当我加载时，我加载了一个不存在的属性。 我不是 100% 为什么需要负载，但请参阅这篇循环遍历工作表的帖子 --> https://stackoverflow.com/a/50285934/5079799

无论如何，这里是我构建的 function，您可以将 Header_Footer_Obj 传递给并可选择指定工作表/工作表或什么都不指定（活动表）。

async function Set_Header_Footer(context, Header_Footer_Obj, Opt_All_WSs, Opt_WS) {
    if (Opt_All_WSs == true) {
        var sheets = context.workbook.worksheets;
        sheets.load("$none");
        await context.sync();
        sheets.items.forEach(sheet => sheet.pageLayout.headersFooters.defaultForAllPages.set(Header_Footer_Obj, false));
        return context;
    }
    if (Opt_WS != undefined) {
        return Opt_WS.pageLayout.headersFooters.defaultForAllPages.set(Header_Footer_Obj, false);    
    }
    if (Opt_WS == undefined && Opt_All_WSs != true) {
        return context.workbook.worksheets.getActiveWorksheet().pageLayout.headersFooters.defaultForAllPages.set(Header_Footer_Obj, false);    
    }
}

测试：

var Header_Footer_Obj = {
    leftHeader: 'leftHeader',
    centerHeader: 'centerHeader',
    rightHeader: 'rightHeader',
    leftFooter: 'leftFooter',
    centerFooter: 'centerFooter',
    rightFooter: 'rightFooter',
}
await Set_Header_Footer(context, Header_Footer_Obj, true)

var Header_Footer_Obj = {
    leftHeader: '2leftHeader',
    centerHeader: '2centerHeader',
    rightHeader: null,
    leftFooter: '2leftFooter',
    centerFooter: null,
    rightFooter: '2rightFooter',
}

var ws = context.workbook.worksheets.getItem("Sheet2")
await Set_Header_Footer(context, Header_Footer_Obj, false, ws)

var Header_Footer_Obj = {
    leftHeader: 'getActiveWorksheet',
    centerHeader: 'getActiveWorksheet',
    rightHeader: null,
    leftFooter: 'getActiveWorksheet',
    centerFooter: null,
    rightFooter: 'getActiveWorksheet',
}
await Set_Header_Footer(context, Header_Footer_Obj, false)