deleteHeaderFooterShapes method

deleteHeaderFooterShapes()

Deletes all shapes (drawing objects) from the headers and footers of this section.

deleteHeaderFooterShapes()

Examples

Shows how to remove all shapes from all headers footers in a section.

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

// Create a primary header with a shape.
builder.moveToHeaderFooter(aw.HeaderFooterType.HeaderPrimary);
builder.insertShape(aw.Drawing.ShapeType.Rectangle, 100, 100);

// Create a primary footer with an image.
builder.moveToHeaderFooter(aw.HeaderFooterType.FooterPrimary);
builder.insertImage(base.imageDir + "Logo icon.ico");

expect(doc.firstSection.headersFooters.getByHeaderFooterType(aw.HeaderFooterType.HeaderPrimary).getChildNodes(aw.NodeType.Shape, true).count).toEqual(1);
expect(doc.firstSection.headersFooters.getByHeaderFooterType(aw.HeaderFooterType.FooterPrimary).getChildNodes(aw.NodeType.Shape, true).count).toEqual(1);

// Remove all shapes from the headers and footers in the first section.
doc.firstSection.deleteHeaderFooterShapes();

expect(doc.firstSection.headersFooters.getByHeaderFooterType(aw.HeaderFooterType.HeaderPrimary).getChildNodes(aw.NodeType.Shape, true).count).toEqual(0);
expect(doc.firstSection.headersFooters.getByHeaderFooterType(aw.HeaderFooterType.FooterPrimary).getChildNodes(aw.NodeType.Shape, true).count).toEqual(0);

See Also

Section.clone method Section.ensureMinimum method