docx
    Preparing search index...

    Type Alias IPropertiesOptions

    Options for configuring document properties.

    type IPropertiesOptions = {
        background?: IDocumentBackgroundOptions;
        bibliography?: DocumentBibliography;
        comments?: ICommentsOptions;
        compatabilityModeVersion?: number;
        compatibility?: ICompatibilityOptions;
        creator?: string;
        customProperties?: readonly ICustomPropertyOptions[];
        defaultTabStop?: number;
        description?: string;
        endnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>;
        evenAndOddHeaderAndFooters?: boolean;
        externalStyles?: string;
        features?: { trackRevisions?: boolean; updateFields?: boolean };
        fonts?: readonly FontOptions[];
        footnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>;
        hyphenation?: IHyphenationOptions;
        keywords?: string;
        lastModifiedBy?: string;
        macros?: DocumentMacros;
        numbering?: INumberingOptions;
        pageNumbers?: PageNumberEstimator;
        protection?: IDocumentProtectionOptions;
        revision?: number;
        sections: readonly ISectionOptions[];
        styles?: IStylesOptions;
        subject?: string;
        theme?: IThemeOptions;
        title?: string;
    }
    Index
    background? bibliography? comments? compatabilityModeVersion? compatibility? creator? customProperties? defaultTabStop? description? endnotes? evenAndOddHeaderAndFooters? externalStyles? features? fonts? footnotes? hyphenation? keywords? lastModifiedBy? macros? numbering? pageNumbers? protection? revision? sections styles? subject? theme? title?
    background?: IDocumentBackgroundOptions

    Document background settings

    bibliography?: DocumentBibliography

    The sources the document's citations and bibliographies refer to

    comments?: ICommentsOptions

    Document comments configuration

    compatabilityModeVersion?: number

    Compatibility mode version

    compatibility?: ICompatibilityOptions

    Compatibility settings

    creator?: string

    Document creator/author

    customProperties?: readonly ICustomPropertyOptions[]

    Custom document properties

    defaultTabStop?: number

    Default tab stop width in twips, half an inch (720) when not given

    description?: string

    Document description

    endnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>
    evenAndOddHeaderAndFooters?: boolean

    Enable different headers/footers for even/odd pages

    externalStyles?: string

    External stylesheet reference

    features?: { trackRevisions?: boolean; updateFields?: boolean }

    Document features like track changes

    fonts?: readonly FontOptions[]

    Font configurations

    footnotes?: Readonly<Record<string, { children: readonly Paragraph[] }>>

    Document footnotes

    hyphenation?: IHyphenationOptions

    Hyphenation settings

    keywords?: string

    Document keywords for searchability

    lastModifiedBy?: string

    User who last modified the document

    macros?: DocumentMacros

    The document's VBA macros, which make it a macro-enabled document (.docm)

    numbering?: INumberingOptions

    Numbering configuration

    pageNumbers?: PageNumberEstimator

    Works out the page each bookmark is on, so the page numbers of tables of contents and page references are written with the document

    protection?: IDocumentProtectionOptions

    What people can change in the document in Word, and the password that turns that protection off

    revision?: number

    Revision number

    sections: readonly ISectionOptions[]

    Document section configurations

    styles?: IStylesOptions

    Document styles configuration

    subject?: string

    Document subject

    theme?: IThemeOptions

    The document's theme: its colors, and its fonts for headings and body text

    title?: string

    Document title

    Settings
    Member Visibility

    On This Page
    Properties