ReferenceHeaders & Footers
Headers & Footers operations
Structure, references, and part lifecycle for document headers and footers.
13 operations. Names, descriptions, and behavior flags come from the canonical contract.
Operations
headerFooters.getGet a single header/footer slot entry by address.readheaderFooters.listList header/footer slot entries across sections.readheaderFooters.pageNumbers.getRead where a section shows page numbers, their alignment, the first-page choice, and the section's number style and start. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.readheaderFooters.pageNumbers.insertAtomically number a section's pages with a live PAGE field in its header or footer, with alignment, a first-page choice, and an optional number style and start. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.mutatesheaderFooters.pageNumbers.removeAtomically remove a section's PAGE fields from its header, footer, or both, keeping other header and footer content. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.mutatesheaderFooters.pageNumbers.setAtomically add a section's page numbers or change them: move them between header and footer, realign them, show or hide them on the first page, and set the number style and start. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.mutatesheaderFooters.parts.createCreate a new independent header/footer part, optionally cloned from an existing part.mutatesheaderFooters.parts.deleteDelete a header/footer part and its associated relationship when no section slots reference it.mutatesheaderFooters.parts.listList unique header/footer part records from document relationships.readheaderFooters.refs.clearClear an explicit header/footer reference from a section slot.mutatesheaderFooters.refs.setSet an explicit header/footer reference on a section slot.mutatesheaderFooters.refs.setLinkedToPreviousLink or unlink a header/footer slot to/from the previous section.mutatesheaderFooters.resolveResolve the effective header/footer reference for a slot, walking the section inheritance chain.read