API 参考

中文 API 参考按对象和脚本操作分组。请从下面的对象地图直接进入具体页面， 避免在旧版根目录长文档里查找 API 能力。 如果需要按任务串起完整流程，请先读 Word 文档处理工作流。

语言

如何阅读这些页面

API 页面按公开 C++ 对象拆分，而不是继续维护一篇很长的 README 式文档。 每个专题页应尽量提供：

  • 来自 include/featherdoc.hpp 的完整公开签名。

  • 类型化参数、默认值、单位，以及从 0 开始的索引规则。

  • 返回值语义，包括成功、失败和 std::optional 为空的含义。

  • 能直接看出调用方式的短示例。

公开 include 入口

新的 C++ 调用方应优先包含覆盖所需类型的最小领域头文件。<featherdoc.hpp> 继续作为兼容聚合入口，适合需要一次性引入完整公开 API 的旧代码或示例。

  • <featherdoc/document.hpp> 暴露 Document 根对象。

  • <featherdoc/document_core.hpp> 暴露共享文档模型、错误、检查 summary、 分节、页面设置、图片、内容控件和语义差异数据。

  • <featherdoc/tables.hpp> 暴露 Table、TableRow、TableCell 和 表格检查 summary。

  • <featherdoc/templates.hpp> 暴露模板 schema、校验、onboarding 和相关辅助 API。

  • <featherdoc/template_part.hpp> 暴露 TemplatePart。

  • <featherdoc/styles_numbering.hpp> 暴露样式、编号和表格样式质量模型。

  • <featherdoc/reviews_fields.hpp> 暴露字段、超链接、脚注尾注、批注、修订和 OMML 辅助能力。

  • <featherdoc/text.hpp> 暴露 Paragraph 和 Run。

  • <featherdoc/fwd.hpp> 暴露轻量前置声明。

  • <featherdoc/core.hpp> 继续作为旧分组入口的兼容聚合头文件。

对象地图

对象

可以用来做什么

常用入口

featherdoc::Document

加载、保存、检查和修改 .docx 包的根对象。

Document

Word 文档处理工作流

按任务串起文档生成、填充、审阅和批量编辑流程。

Word 文档处理工作流

featherdoc::Paragraph / featherdoc::Run

编辑正文文本和 run 级格式。

Paragraph 和 Run

featherdoc::Table / TableRow / TableCell

编辑表格结构、宽度、边框、合并状态和单元格内容。

Table、TableRow 和 TableCell

featherdoc::inline_image_info / drawing_image_info

检查图片元数据，追加行内或浮动图片，并提取、替换或删除图片。

图片 API

featherdoc::section_page_setup / page_margins

管理分节结构、页面设置，以及分节解析后的页眉页脚。

分节和页面设置 API

字段、链接、脚注、批注和修订

管理 Word 字段、超链接、脚注、尾注、批注和跟踪修订。

字段、链接和审阅 API

样式和编号

检查样式、重构样式、管理编号目录和默认格式。

样式和编号 API

featherdoc::TemplatePart

把正文、页眉、页脚和分节部件统一纳入模板替换流程。

TemplatePart

编辑计划操作

scripts/edit_document_from_plan.ps1 接收的 JSON operation 名称索引。

编辑计划操作

PDF 工作流

实验性 export-pdf 和 import-pdf CLI 工作流、JSON 诊断和支持范围。

PDF 工作流

inspection summary 结构体

暴露内容控件、表格、字段、图片和语义差异等只读检查结果，以及通用枚举选项。

枚举和通用选项类型

中文核心对象