福昕开发者文档中心

页眉页脚 ​

福昕 PDF SDK（Web）支持为 PDF 文档添加、读取、更新和移除页眉页脚。常用接口包括：

  • PDFDoc.addHeaderFooter()
  • PDFDoc.getHeaderFooter()
  • PDFDoc.updateHeaderFooter()
  • PDFDoc.removeHeaderFooter()

页眉页脚会写入 PDF 内容，适合添加页码、文档编号、日期或固定说明。修改后需要导出文档保存结果。

添加页眉页脚 ​

PDFDoc.addHeaderFooter(headerFooter) 用于添加页眉页脚。

javascript
await pdfDoc.addHeaderFooter({
    pageRange: [[0, pdfDoc.getPageCount() - 1]],
    header: {
        center: {
            text: 'Foxit PDF SDK Web'
        }
    },
    footer: {
        right: {
            text: 'Page <PageNumber>'
        }
    }
});

读取页眉页脚 ​

javascript
const headerFooter = await pdfDoc.getHeaderFooter();

读取结果可用于判断文档是否已有页眉页脚，或作为更新时的基础数据。

更新页眉页脚 ​

PDFDoc.updateHeaderFooter(headerFooter) 用于更新已有页眉页脚。

javascript
const headerFooter = await pdfDoc.getHeaderFooter();

await pdfDoc.updateHeaderFooter({
    ...headerFooter,
    footer: {
        center: {
            text: 'Confidential'
        }
    }
});

移除页眉页脚 ​

javascript
await pdfDoc.removeHeaderFooter();

保存修改 ​

添加、更新或移除页眉页脚后，需要导出文档保存结果。

javascript
const file = await pdfDoc.getFile({
    fileName: 'header-footer.pdf'
});

注意事项 ​

  • 页眉页脚会修改 PDF 内容，执行前建议确认用户是否需要保存该变更。
  • 页面索引从 0 开始。
  • 如果文档已经包含页眉页脚，更新前建议先调用 getHeaderFooter() 读取现有配置。
  • 保存结果时应使用 PDFDoc.getFile() 导出修改后的文件。