OfficeDocument | /src/files/OfficeDocument.ts | docxml@5.3.1

class OfficeDocument

extends XmlFile

import { OfficeDocument } from "https://deno.land/x/docxml@5.3.1/src/files/OfficeDocument.ts";

Constructors

new

OfficeDocument(location: string, relationships?)

Properties

readonly

children: Promise<OfficeDocumentChild[]>

The components normalized from #root, which is potentially arrayed, promised, array promised etc.

readonly

comments: Comments

The API representing "comments.xml" and all the comments associated with this document.

readonly

footers: { add: (location: string, root: HeaderFooterRoot) => unknown; }

readonly

headers: { add: (location: string, root: HeaderFooterRoot) => unknown; }

readonly

numbering: Numbering

The API representing "numbering.xml" and all the numbering styles/schemes

readonly

relationships: Relationships

readonly

settings: Settings

The API representing "settings.xml" and all the settings associated with this document.

readonly

styles: Styles

The API representing "styles.xml" and all the text/paragraph/table styles associated with this document.

Methods

protected

toNode(): Promise<Document>

getRelated(): File[]

Get all XmlFile instances related to this one, including self. This helps the system serialize itself back to DOCX fullly. Probably not useful for consumers of the library.

set(root: OfficeDocumentRoot): void

Set the contents of the document

Static Properties

contentType

Static Methods

fromArchive(archive: Archive, location: string): Promise<OfficeDocument>

Instantiate this class by looking at the DOCX XML for it.