Aspose::Words::HeaderFooter class

HeaderFooter class

Represents a container for the header or footer text of a section. To learn more, visit the Working with Headers and Footers documentation article.

class HeaderFooter : public Aspose::Words::Story

Methods

Method	Description
Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Accepts a visitor.
AcceptEnd(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Accepts a visitor for visiting the end of the header.
AcceptStart(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Accepts a visitor for visiting the start of the header.
AppendChild(T)
AppendParagraph(const System::String&)	A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object.
Clone(bool)	Creates a duplicate of the node.
DeleteShapes()	Deletes all shapes from the text of this story.
get_Count()	Gets the number of immediate children of this node.
get_CustomNodeId() const	Specifies custom node identifier.
virtual get_Document() const	Gets the document to which this node belongs.
get_FirstChild() const	Gets the first child of the node.
get_FirstParagraph() override	Gets the first paragraph in the story.
get_HasChildNodes()	Returns true if this node has any child nodes.
get_HeaderFooterType()	Gets the type of this header/footer.
get_IsComposite() override	Returns true as this node can have child nodes.
get_IsHeader()	True if this HeaderFooter object is a header.
get_IsLinkedToPrevious()	True if this header or footer is linked to the corresponding header or footer in the previous section.
get_LastChild() const	Gets the last child of the node.
get_LastParagraph() override	Gets the last paragraph in the story.
get_NextNode() const
get_NextSibling()	Gets the node immediately following this node.
get_NodeType() const override	Returns HeaderFooter.
get_Paragraphs() override	Gets a collection of paragraphs that are immediate children of the story.
get_ParentNode()	Gets the immediate parent of this node.
get_ParentSection()	Gets the parent section of this story.
get_PreviousSibling()	Gets the node immediately preceding this node.
get_PrevNode() const
get_Range()	Returns a Range object that represents the portion of a document that is contained in this node.
get_StoryType() override	Gets the type of this story.
get_Tables() override	Gets a collection of tables that are immediate children of the story.
GetAncestor(Aspose::Words::NodeType)	Gets the first ancestor of the specified NodeType.
GetAncestorOf()
GetChild(Aspose::Words::NodeType, int32_t, bool)	Returns an Nth child node that matches the specified type.
GetChildNodes(Aspose::Words::NodeType, bool)	Returns a live collection of child nodes that match the specified type.
GetEnumerator() override	Provides support for the for each style iteration over the child nodes of this node.
GetText() override	Gets the text of this node and of all its children.
GetType() const override
HeaderFooter(const System::SharedPtr<Aspose::Words::DocumentBase>&, Aspose::Words::HeaderFooterType)	Creates a new header or footer of the specified type.
IndexOf(const System::SharedPtr<Aspose::Words::Node>&)	Returns the index of the specified child node in the child node array.
InsertAfter(T, const System::SharedPtr<Aspose::Words::Node>&)
InsertBefore(T, const System::SharedPtr<Aspose::Words::Node>&)
Is(const System::TypeInfo&) const override
IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&)
NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Gets next node according to the pre-order tree traversal algorithm.
static NodeTypeToString(Aspose::Words::NodeType)	A utility method that converts a node type enum value into a user friendly string.
PrependChild(T)
PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Gets the previous node according to the pre-order tree traversal algorithm.
Remove()	Removes itself from the parent.
RemoveAllChildren()	Removes all the child nodes of the current node.
RemoveChild(T)
RemoveSmartTags()	Removes all SmartTag descendant nodes of the current node.
SelectNodes(const System::String&)	Selects a list of nodes matching the XPath expression.
SelectSingleNode(const System::String&)	Selects the first Node that matches the XPath expression.
set_CustomNodeId(int32_t)	Setter for Aspose::Words::Node::get_CustomNodeId.
set_IsLinkedToPrevious(bool)	Setter for Aspose::Words::HeaderFooter::get_IsLinkedToPrevious.
set_NextNode(const System::SharedPtr<Aspose::Words::Node>&)
set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&)
SetParent(const System::SharedPtr<Aspose::Words::Node>&)
SetTemplateWeakPtr(uint32_t) override
ToString(Aspose::Words::SaveFormat)	Exports the content of the node into a string in the specified format.
ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)	Exports the content of the node into a string using the specified save options.
static Type()

Remarks

HeaderFooter can contain Paragraph and Table child nodes.

HeaderFooter is a section-level node and can only be a child of Section. There can only be one HeaderFooter of each HeaderFooterType in a Section.

If Section does not have a HeaderFooter of a specific type or the HeaderFooter has no child nodes, this header/footer is considered linked to the header/footer of the same type of the previous section in Microsoft Word.

When HeaderFooter contains at least one Paragraph, it is no longer considered linked to previous in Microsoft Word.

Examples

Shows how to create a header and a footer.

auto doc = MakeObject<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.
auto header = MakeObject<HeaderFooter>(doc, HeaderFooterType::HeaderPrimary);
doc->get_FirstSection()->get_HeadersFooters()->Add(header);

SharedPtr<Paragraph> para = header->AppendParagraph(u"My header.");

ASSERT_TRUE(header->get_IsHeader());
ASSERT_TRUE(para->get_IsEndOfHeaderFooter());

// 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.
auto footer = MakeObject<HeaderFooter>(doc, HeaderFooterType::FooterPrimary);
doc->get_FirstSection()->get_HeadersFooters()->Add(footer);

para = footer->AppendParagraph(u"My footer.");

ASSERT_FALSE(footer->get_IsHeader());
ASSERT_TRUE(para->get_IsEndOfHeaderFooter());

ASPOSE_ASSERT_EQ(footer, para->get_ParentStory());
ASPOSE_ASSERT_EQ(footer->get_ParentSection(), para->get_ParentSection());
ASPOSE_ASSERT_EQ(footer->get_ParentSection(), header->get_ParentSection());

doc->Save(ArtifactsDir + u"HeaderFooter.Create.docx");

Shows how to delete all footers from a document.

auto doc = MakeObject<Document>(MyDir + u"Header and footer types.docx");

// Iterate through each section and remove footers of every kind.
for (const auto& section : System::IterateOver(doc->LINQ_OfType<SharedPtr<Section>>()))
{
    // There are three kinds of footer and header types.
    // 1 -  The "First" header/footer, which only appears on the first page of a section.
    SharedPtr<HeaderFooter> footer = section->get_HeadersFooters()->idx_get(HeaderFooterType::FooterFirst);
    if (footer != nullptr)
    {
        footer->Remove();
    }

    // 2 -  The "Primary" header/footer, which appears on odd pages.
    footer = section->get_HeadersFooters()->idx_get(HeaderFooterType::FooterPrimary);
    if (footer != nullptr)
    {
        footer->Remove();
    }

    // 3 -  The "Even" header/footer, which appears on even pages.
    footer = section->get_HeadersFooters()->idx_get(HeaderFooterType::FooterEven);
    if (footer != nullptr)
    {
        footer->Remove();
    }

    ASSERT_EQ(0,
              section->get_HeadersFooters()->LINQ_Count([](SharedPtr<Node> hf) { return !(System::ExplicitCast<HeaderFooter>(hf))->get_IsHeader(); }));
}

doc->Save(ArtifactsDir + u"HeaderFooter.RemoveFooters.docx");

Shows how to replace text in a document’s footer.

auto doc = MakeObject<Document>(MyDir + u"Footer.docx");

SharedPtr<HeaderFooterCollection> headersFooters = doc->get_FirstSection()->get_HeadersFooters();
SharedPtr<HeaderFooter> footer = headersFooters->idx_get(HeaderFooterType::FooterPrimary);

auto options = MakeObject<FindReplaceOptions>();
options->set_MatchCase(false);
options->set_FindWholeWordsOnly(false);

int currentYear = System::DateTime::get_Now().get_Year();
footer->get_Range()->Replace(u"(C) 2006 Aspose Pty Ltd.", String::Format(u"Copyright (C) {0} by Aspose Pty Ltd.", currentYear), options);

doc->Save(ArtifactsDir + u"HeaderFooter.ReplaceText.docx");

Aspose::Words::HeaderFooter class

HeaderFooter class

Methods

Remarks

Examples

See Also