HeaderFooterType enumeration

HeaderFooterType enumeration

Identifies the type of header or footer found in a Word file.

Members

NameDescription
HeaderEvenHeader for even numbered pages.
HeaderPrimaryPrimary header, also used for odd numbered pages.
FooterEvenFooter for even numbered pages.
FooterPrimaryPrimary footer, also used for odd numbered pages.
HeaderFirstHeader for the first page of the section.
FooterFirstFooter for the first page of the section.

Examples

Shows how to create headers and footers in a document using DocumentBuilder.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

// Specify that we want different headers and footers for first, even and odd pages.
builder.pageSetup.differentFirstPageHeaderFooter = true;
builder.pageSetup.oddAndEvenPagesHeaderFooter = true;

// Create the headers, then add three pages to the document to display each header type.
builder.moveToHeaderFooter(aw.HeaderFooterType.HeaderFirst);
builder.write("Header for the first page");
builder.moveToHeaderFooter(aw.HeaderFooterType.HeaderEven);
builder.write("Header for even pages");
builder.moveToHeaderFooter(aw.HeaderFooterType.HeaderPrimary);
builder.write("Header for all other pages");

builder.moveToSection(0);
builder.writeln("Page1");
builder.insertBreak(aw.BreakType.PageBreak);
builder.writeln("Page2");
builder.insertBreak(aw.BreakType.PageBreak);
builder.writeln("Page3");

doc.save(base.artifactsDir + "DocumentBuilder.HeadersAndFooters.docx");

See Also