JavaScript API: addHeader

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addHeader

PREMIUM

TRIAL / ADVANCED

Adds header.

Note

You are reading the JavaScript API documentation. For the PHP API method please go to addHeader.

Description

addHeader (headers: OptionsHeader[]): this

interface OptionsHeader extends OptionsReference {}

interface OptionsReference {
    /** Replace existing reference in the section. Default as true */
    replaceOthers?: boolean;
    /** Section to add the content. Default as -1 (last section) */
    section?: number | "all";
    /** Content */
    text: WordFragment;
    /** Type. Default as default */
    type?: "default" | "even" | "first";
}

Code samples

Example #1

import {
    CreateDocx,
    OptionsHeader,
    OptionsText,
    WordFragment,
} from "build";
import * as fs from "fs";

const docx = new CreateDocx();

// generate header content
const headers: OptionsHeader[] = [];

const textDefaultHeaderA: OptionsText = {
    bold: true,
    italic: true,
    fontSize: 14,
    text: "Text ",
};
const textDefaultHeaderB: OptionsText = {
    color: "0000FF",
    font: "Times New Roman",
    text: "default header.",
};
const headerFragmentDefault = new WordFragment();
headerFragmentDefault.addText([textDefaultHeaderA, textDefaultHeaderB]);
const headerContentDefault: OptionsHeader = {
    text: headerFragmentDefault,
};

const textFirstHeader: OptionsText = {
    bold: true,
    text: "Text first header.",
};
const headerFragmentFirst = new WordFragment();
headerFragmentFirst.addText([textFirstHeader]);
const headerContentFirst: OptionsHeader = {
    text: headerFragmentFirst,
    type: "first",
};

const headerFragmentEven = new WordFragment();
headerFragmentEven.addText("Text even header.");
const headerContentEven: OptionsHeader = {
    text: headerFragmentEven,
    type: "even",
};

headers.push(headerContentDefault);
headers.push(headerContentFirst);
headers.push(headerContentEven);

// add headers
docx.addHeader(headers);

docx.addText("First page.");
docx.addBreak("page");
docx.addText("Even page.");
docx.addBreak("page");
docx.addText("Other page.");

docx.save().then(contents => {
    fs.writeFileSync("addHeader_1.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.