HeaderFooter constructor
HeaderFooter(doc, header_footer_type)
Creates a new header or footer of the specified type.
def __init__(self, doc: aspose.words.DocumentBase, header_footer_type: aspose.words.HeaderFooterType):
...
Parameter | Type | Description |
---|---|---|
doc | DocumentBase | The owner document. |
header_footer_type | HeaderFooterType | A HeaderFooter.header_footer_type value that specifies the type of the header or footer. |
Remarks
When HeaderFooter is created, it belongs to the specified document, but is not
yet part of the document and Node.parent_node is None
.
To append HeaderFooter to a Section use CompositeNode.insert_after(), CompositeNode.insert_before(), or Section.headers_footers property and methods NodeCollection.add(), NodeCollection.insert().
Examples
Shows how to create a header and a footer.
doc = aw.Document()
# Create a header and append a paragraph to it. The text in that paragraph
# will appear at the top of every page of this section, above the main body text.
header = aw.HeaderFooter(doc, aw.HeaderFooterType.HEADER_PRIMARY)
doc.first_section.headers_footers.add(header)
para = header.append_paragraph('My header.')
self.assertTrue(header.is_header)
self.assertTrue(para.is_end_of_header_footer)
# Create a footer and append a paragraph to it. The text in that paragraph
# will appear at the bottom of every page of this section, below the main body text.
footer = aw.HeaderFooter(doc, aw.HeaderFooterType.FOOTER_PRIMARY)
doc.first_section.headers_footers.add(footer)
para = footer.append_paragraph('My footer.')
self.assertFalse(footer.is_header)
self.assertTrue(para.is_end_of_header_footer)
self.assertEqual(footer, para.parent_story)
self.assertEqual(footer.parent_section, para.parent_section)
self.assertEqual(footer.parent_section, header.parent_section)
doc.save(file_name=ARTIFACTS_DIR + 'HeaderFooter.Create.docx')
See Also
- module aspose.words
- class HeaderFooter