English API Reference

This language-local API entry gives the /en/api/ path a stable structure. Use the object map below to jump directly to focused API pages. For an end-to-end task view, use Word Document Workflows.

Language

• API 参考

• FeatherDoc

How To Read These Pages

The API pages are organized around public C++ objects rather than one long README-style page. Each focused page should expose:

• Full public signatures from include/featherdoc.hpp where the API is a C++ entry point.

• Typed parameters, default values, units, and zero-based index rules.

• Return values with success/failure semantics.

• Short examples that show the intended call shape.

Public Include Entry Points

New C++ code should include the smallest public domain header that covers the types it uses. <featherdoc.hpp> remains the compatibility aggregate when a caller wants the full public API surface in one include.

• <featherdoc/document.hpp> exposes the Document root handle.

• <featherdoc/document_core.hpp> exposes shared document models, errors, inspection summaries, sections, page setup, images, content controls, and semantic diff data.

• <featherdoc/tables.hpp> exposes Table, TableRow, TableCell, and table inspection summaries.

• <featherdoc/templates.hpp> exposes template schema, validation, onboarding, and related helper APIs.

• <featherdoc/template_part.hpp> exposes TemplatePart.

• <featherdoc/styles_numbering.hpp> exposes style, numbering, and table style quality models.

• <featherdoc/reviews_fields.hpp> exposes fields, hyperlinks, notes, comments, revisions, and OMML helpers.

• <featherdoc/text.hpp> exposes Paragraph and Run.

• <featherdoc/fwd.hpp> exposes lightweight forward declarations.

• <featherdoc/core.hpp> remains a compatibility aggregate for existing callers that include the older grouped entry point.

Object Map

Object	What it is for	Entry point
featherdoc::Document	Root handle for opening, saving, inspecting, and mutating .docx files.	Document
Word document workflows	Task-oriented path for generating, filling, reviewing, and batch-editing Word documents.	Word Document Workflows
featherdoc::Paragraph / featherdoc::Run	Text content and run-level formatting.	Paragraph And Run
featherdoc::Table / TableRow / TableCell	Table structure, rows, cells, widths, borders, alignment, and merge state.	Table, TableRow, And TableCell
featherdoc::inline_image_info / drawing_image_info	Image metadata, inline and floating insertion, extraction, replacement, and removal.	Images
featherdoc::section_page_setup / page_margins	Section structure, page setup, and section-resolved header/footer editing.	Sections And Page Setup
Fields, links, notes, comments, and revisions	Word fields, hyperlinks, footnotes, endnotes, comments, and tracked revisions.	Fields, Links, And Review Notes
Styles and numbering	Style inspection, style refactoring, numbering catalogs, and default formatting.	Styles And Numbering
featherdoc::TemplatePart	Shared operations over body, header, footer, and section-specific parts.	TemplatePart
Edit plan operations	JSON operation names accepted by scripts/edit_document_from_plan.ps1.	Edit Plan Operations
PDF workflows	Experimental export-pdf and import-pdf CLI workflows, JSON diagnostics, and supported-scope limits.	PDF Workflows
Inspection summaries	Read-only results and shared enum/option types used by content controls, tables, fields, images, and diffs.	Enums And Common Option Types

Core Objects

• Document
  • Common Tasks
  • Success And Failure Semantics
  • Short C++ Example
  • Typed Signature Guide
  • Lifecycle
  • Open Validation And Resource Limits
  • Explicit Package Repair
  • Handle Invalidation
  • Template Part Access
  • Sections And Inspection
  • Template Filling Shortcuts
  • Body, Tables, And Images
  • Notes, Revisions, And Links
  • Related API Families
  • Examples
• Paragraph And Run
  • Common Tasks
  • Success And Failure Semantics
  • Short Example
  • Typed Signature Guide
  • Paragraph Text And Iteration
  • Paragraph Layout
  • Run Text And Styling
  • Run Language And Direction
  • Example
• Table, TableRow, And TableCell
  • Indexing, Units, And Return Semantics
  • Common Tasks
  • Success And Failure Semantics
  • Short Example
  • Typed Signature Guide
  • Table Structure And Lookup
  • Table Layout, Style, And Borders
  • TableRow
  • TableCell
  • Example
• Images
  • Common Tasks
  • Success And Failure Semantics
  • Short Example
  • Dimension Detection
  • Typed Signature Guide
  • Image Info Types
  • Append Images
  • Inspect And Mutate Images
  • Example
• Sections And Page Setup
  • Typed Signature Guide
  • Section Info Types
  • Section Structure
  • Page Setup
  • Headers And Footers
  • Example
• Fields, Links, And Review Notes
  • Typed Signature Guide
  • Summary Types
  • Fields
  • Hyperlinks
  • Notes, Comments, And Revisions
  • Example
• Styles And Numbering
  • Typed Signature Guide
  • Numbering
  • Styles
  • Default Formatting
  • Table Style Quality
  • Example
• TemplatePart
  • Common Tasks
  • Success And Failure Semantics
  • Short Example
  • Typed Signature Guide
  • Part Basics
  • Bookmarks
  • Content Controls
  • Template Validation
  • Document-Level Schema Workflows
  • Example
• Edit Plan Operations
  • Plan Shape
  • Execution Result
  • Operation Reference
  • JSON Examples
  • Complete Operation Index
• PDF Workflows
  • Build Flags
  • PDF Export
  • PDF Import
  • PDF Import JSON Diagnostics
  • PDF Import Supported Scope And Limits
  • Release Validation
• Enums And Common Option Types
  • Formatting
  • Document Layout
  • Tables
  • Templates And Review