## HeaderFooter class Represents a container for the header or footer text of a section. To learn more, visit the [Working with Headers and Footers](https://docs.aspose.com/words/cpp/working-with-headers-and-footers/) documentation article. ```cpp class HeaderFooter : public Aspose::Words::Story ``` ## Methods | Method | Description | | --- | --- | | [Accept](./accept/)(System::SharedPtr\) override | Accepts a visitor. | | [AcceptEnd](./acceptend/)(System::SharedPtr\) override | Accepts a visitor for visiting the end of the header. | | [AcceptStart](./acceptstart/)(System::SharedPtr\) override | Accepts a visitor for visiting the start of the header. | | [AppendChild](../compositenode/appendchild/)(T) | | | [AppendParagraph](../story/appendparagraph/)(const System::String\&) | A shortcut method that creates a [Paragraph](../paragraph/) object with optional text and appends it to the end of this object. | | [Clone](../node/clone/)(bool) | Creates a duplicate of the node. | | [DeleteShapes](../story/deleteshapes/)() | Deletes all shapes from the text of this story. | | [get_Count](../compositenode/get_count/)() | Gets the number of immediate children of this node. | | [get_CustomNodeId](../node/get_customnodeid/)() const | Specifies custom node identifier. | | virtual [get_Document](../node/get_document/)() const | Gets the document to which this node belongs. | | [get_FirstChild](../compositenode/get_firstchild/)() const | Gets the first child of the node. | | [get_FirstParagraph](../story/get_firstparagraph/)() override | Gets the first paragraph in the story. | | [get_HasChildNodes](../compositenode/get_haschildnodes/)() | Returns **true** if this node has any child nodes. | | [get_HeaderFooterType](./get_headerfootertype/)() | Gets the type of this header/footer. | | [get_IsComposite](../compositenode/get_iscomposite/)() override | Returns **true** as this node can have child nodes. | | [get_IsHeader](./get_isheader/)() | True if this [HeaderFooter](./) object is a header. | | [get_IsLinkedToPrevious](./get_islinkedtoprevious/)() | True if this header or footer is linked to the corresponding header or footer in the previous section. | | [get_LastChild](../compositenode/get_lastchild/)() const | Gets the last child of the node. | | [get_LastParagraph](../story/get_lastparagraph/)() override | Gets the last paragraph in the story. | | [get_NextNode](../node/get_nextnode/)() const | | | [get_NextSibling](../node/get_nextsibling/)() | Gets the node immediately following this node. | | [get_NodeType](./get_nodetype/)() const override | Returns [HeaderFooter](../nodetype/). | | [get_Paragraphs](../story/get_paragraphs/)() override | Gets a collection of paragraphs that are immediate children of the story. | | [get_ParentNode](../node/get_parentnode/)() | Gets the immediate parent of this node. | | [get_ParentSection](./get_parentsection/)() | Gets the parent section of this story. | | [get_PreviousSibling](../node/get_previoussibling/)() | Gets the node immediately preceding this node. | | [get_PrevNode](../node/get_prevnode/)() const | | | [get_Range](../node/get_range/)() | Returns a [Range](../range/) object that represents the portion of a document that is contained in this node. | | [get_StoryType](../story/get_storytype/)() override | Gets the type of this story. | | [get_Tables](../story/get_tables/)() override | Gets a collection of tables that are immediate children of the story. | | [GetAncestor](../node/getancestor/)(Aspose::Words::NodeType) | Gets the first ancestor of the specified [NodeType](../nodetype/). | | [GetAncestorOf](../node/getancestorof/)() | | | [GetChild](../compositenode/getchild/)(Aspose::Words::NodeType, int32_t, bool) | Returns an Nth child node that matches the specified type. | | [GetChildNodes](../compositenode/getchildnodes/)(Aspose::Words::NodeType, bool) | Returns a live collection of child nodes that match the specified type. | | [GetEnumerator](../compositenode/getenumerator/)() override | Provides support for the for each style iteration over the child nodes of this node. | | [GetText](../compositenode/gettext/)() override | Gets the text of this node and of all its children. | | [GetType](./gettype/)() const override | | | [HeaderFooter](./headerfooter/)(const System::SharedPtr\\&, Aspose::Words::HeaderFooterType) | Creates a new header or footer of the specified type. | | [IndexOf](../compositenode/indexof/)(const System::SharedPtr\\&) | Returns the index of the specified child node in the child node array. | | [InsertAfter](../compositenode/insertafter/)(T, const System::SharedPtr\\&) | | | [InsertBefore](../compositenode/insertbefore/)(T, const System::SharedPtr\\&) | | | [Is](./is/)(const System::TypeInfo\&) const override | | | [IsAncestorNode](../node/isancestornode/)(const System::SharedPtr\\&) | | | [NextPreOrder](../node/nextpreorder/)(const System::SharedPtr\\&) | Gets next node according to the pre-order tree traversal algorithm. | | static [NodeTypeToString](../node/nodetypetostring/)(Aspose::Words::NodeType) | A utility method that converts a node type enum value into a user friendly string. | | [PrependChild](../compositenode/prependchild/)(T) | | | [PreviousPreOrder](../node/previouspreorder/)(const System::SharedPtr\\&) | Gets the previous node according to the pre-order tree traversal algorithm. | | [Remove](../node/remove/)() | Removes itself from the parent. | | [RemoveAllChildren](../compositenode/removeallchildren/)() | Removes all the child nodes of the current node. | | [RemoveChild](../compositenode/removechild/)(T) | | | [RemoveSmartTags](../compositenode/removesmarttags/)() | Removes all [SmartTag](../../aspose.words.markup/smarttag/) descendant nodes of the current node. | | [SelectNodes](../compositenode/selectnodes/)(const System::String\&) | Selects a list of nodes matching the XPath expression. | | [SelectSingleNode](../compositenode/selectsinglenode/)(const System::String\&) | Selects the first [Node](../node/) that matches the XPath expression. | | [set_CustomNodeId](../node/set_customnodeid/)(int32_t) | Setter for [Aspose::Words::Node::get_CustomNodeId](../node/get_customnodeid/). | | [set_IsLinkedToPrevious](./set_islinkedtoprevious/)(bool) | Setter for [Aspose::Words::HeaderFooter::get_IsLinkedToPrevious](./get_islinkedtoprevious/). | | [set_NextNode](../node/set_nextnode/)(const System::SharedPtr\\&) | | | [set_PrevNode](../node/set_prevnode/)(const System::SharedPtr\\&) | | | [SetParent](../node/setparent/)(const System::SharedPtr\\&) | | | [ToString](../node/tostring/)(Aspose::Words::SaveFormat) | Exports the content of the node into a string in the specified format. | | [ToString](../node/tostring/)(const System::SharedPtr\\&) | Exports the content of the node into a string using the specified save options. | | static [Type](./type/)() | | ## Remarks [HeaderFooter](./) can contain [Paragraph](../paragraph/) and [Table](../../aspose.words.tables/table/) child nodes. [HeaderFooter](./) is a section-level node and can only be a child of [Section](../section/). There can only be one [HeaderFooter](./) of each [HeaderFooterType](./get_headerfootertype/) in a [Section](../section/). If [Section](../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](../paragraph/), it is no longer considered linked to previous in Microsoft Word. ## Examples Shows how to create a header and a footer. ```cpp auto doc = System::MakeObject(); // 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 = System::MakeObject(doc, HeaderFooterType::HeaderPrimary); doc->get_FirstSection()->get_HeadersFooters()->Add(header); System::SharedPtr 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 = System::MakeObject(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(get_ArtifactsDir() + u"HeaderFooter.Create.docx"); ``` Shows how to delete all footers from a document. ```cpp auto doc = System::MakeObject(System::String(get_MyDir() + u"Header and footer types.docx")); // Iterate through each section and remove footers of every kind. for (auto&& section : System::IterateOver(doc->LINQ_OfType>())) { // There are three kinds of footer and header types. // 1 - The "First" header/footer, which only appears on the first page of a section. System::SharedPtr footer = section->get_HeadersFooters()->idx_get(HeaderFooterType::FooterFirst); System::SharedPtr condExpression = footer; if (condExpression != nullptr) { condExpression->Remove(); } // 2 - The "Primary" header/footer, which appears on odd pages. footer = section->get_HeadersFooters()->idx_get(HeaderFooterType::FooterPrimary); System::SharedPtr condExpression2 = footer; if (condExpression2 != nullptr) { condExpression2->Remove(); } // 3 - The "Even" header/footer, which appears on even pages. footer = section->get_HeadersFooters()->idx_get(HeaderFooterType::FooterEven); System::SharedPtr condExpression3 = footer; if (condExpression3 != nullptr) { condExpression3->Remove(); } ASSERT_EQ(0, section->get_HeadersFooters()->LINQ_Count(static_cast, bool>>(static_cast hf)>>([](System::SharedPtr hf) -> bool { return !(System::ExplicitCast(hf))->get_IsHeader(); })))); } doc->Save(get_ArtifactsDir() + u"HeaderFooter.RemoveFooters.docx"); ``` Shows how to replace text in a document's footer. ```cpp auto doc = System::MakeObject(System::String(get_MyDir() + u"Footer.docx")); System::SharedPtr headersFooters = doc->get_FirstSection()->get_HeadersFooters(); System::SharedPtr footer = headersFooters->idx_get(HeaderFooterType::FooterPrimary); auto options = System::MakeObject(); options->set_MatchCase(false); options->set_FindWholeWordsOnly(false); int32_t currentYear = System::DateTime::get_Now().get_Year(); footer->get_Range()->Replace(u"(C) 2006 Aspose Pty Ltd.", System::String::Format(u"Copyright (C) {0} by Aspose Pty Ltd.", currentYear), options); doc->Save(get_ArtifactsDir() + u"HeaderFooter.ReplaceText.docx"); ``` ## See Also * Class [Story](../story/) * Namespace [Aspose::Words](../) * Library [Aspose.Words for C++](../../)