## HeaderFooter class Представляет контейнер для текста верхнего или нижнего колонтитула раздела. Чтобы узнать больше, посетите статью документации [Working with Headers and Footers](https://docs.aspose.com/words/cpp/working-with-headers-and-footers/). ```cpp class HeaderFooter : public Aspose::Words::Story ``` ## Методы | Метод | Описание | | --- | --- | | [Accept](./accept/)(System::SharedPtr\) override | Принимает посетителя. | | [AcceptEnd](./acceptend/)(System::SharedPtr\) override | Принимает посетителя для посещения конца заголовка. | | [AcceptStart](./acceptstart/)(System::SharedPtr\) override | Принимает посетителя для посещения начала заголовка. | | [AppendChild](../compositenode/appendchild/)(T) | | | [AppendParagraph](../story/appendparagraph/)(const System::String\&) | Метод‑ярлык, который создает объект [Paragraph](../paragraph/) с необязательным текстом и добавляет его в конец этого объекта. | | [Clone](../node/clone/)(bool) | Создаёт дубликат узла. | | [DeleteShapes](../story/deleteshapes/)() | Удаляет все фигуры из текста этой истории. | | [get_Count](../compositenode/get_count/)() | Возвращает количество непосредственных дочерних элементов этого узла. | | [get_CustomNodeId](../node/get_customnodeid/)() const | Указывает пользовательский идентификатор узла. | | virtual [get_Document](../node/get_document/)() const | Возвращает документ, к которому принадлежит этот узел. | | [get_FirstChild](../compositenode/get_firstchild/)() const | Возвращает первого дочернего узла. | | [get_FirstParagraph](../story/get_firstparagraph/)() override | Возвращает первый абзац в истории. | | [get_HasChildNodes](../compositenode/get_haschildnodes/)() | Возвращает **true**, если у этого узла есть дочерние узлы. | | [get_HeaderFooterType](./get_headerfootertype/)() | Получает тип этого заголовка/нижнего колонтитула. | | [get_IsComposite](../compositenode/get_iscomposite/)() override | Возвращает **true**, поскольку этот узел может иметь дочерние узлы. | | [get_IsHeader](./get_isheader/)() | True, если этот объект [HeaderFooter](./) является заголовком. | | [get_IsLinkedToPrevious](./get_islinkedtoprevious/)() | True, если этот заголовок или нижний колонтитул связан с соответствующим заголовком или нижним колонтитулом в предыдущем разделе. | | [get_LastChild](../compositenode/get_lastchild/)() const | Возвращает последнего дочернего узла. | | [get_LastParagraph](../story/get_lastparagraph/)() override | Возвращает последний абзац в истории. | | [get_NextNode](../node/get_nextnode/)() const | | | [get_NextSibling](../node/get_nextsibling/)() | Возвращает узел, непосредственно следующий за этим узлом. | | [get_NodeType](./get_nodetype/)() const override | Возвращает [HeaderFooter](../nodetype/). | | [get_Paragraphs](../story/get_paragraphs/)() override | Возвращает коллекцию абзацев, которые являются непосредственными дочерними элементами истории. | | [get_ParentNode](../node/get_parentnode/)() | Возвращает непосредственного родителя этого узла. | | [get_ParentSection](./get_parentsection/)() | Получает родительский раздел этой истории. | | [get_PreviousSibling](../node/get_previoussibling/)() | Возвращает узел, непосредственно предшествующий этому узлу. | | [get_PrevNode](../node/get_prevnode/)() const | | | [get_Range](../node/get_range/)() | Возвращает объект [Range](../range/), представляющий часть документа, содержащуюся в этом узле. | | [get_StoryType](../story/get_storytype/)() override | Возвращает тип этой истории. | | [get_Tables](../story/get_tables/)() override | Возвращает коллекцию таблиц, которые являются непосредственными дочерними элементами истории. | | [GetAncestor](../node/getancestor/)(Aspose::Words::NodeType) | Получает первого предка указанного [NodeType](../nodetype/). | | [GetAncestorOf](../node/getancestorof/)() | | | [GetChild](../compositenode/getchild/)(Aspose::Words::NodeType, int32_t, bool) | Возвращает N‑й дочерний узел, соответствующий указанному типу. | | [GetChildNodes](../compositenode/getchildnodes/)(Aspose::Words::NodeType, bool) | Возвращает живую коллекцию дочерних узлов, соответствующих указанному типу. | | [GetEnumerator](../compositenode/getenumerator/)() override | Обеспечивает поддержку итерации в стиле foreach по дочерним узлам этого узла. | | [GetText](../compositenode/gettext/)() override | Получает текст этого узла и всех его дочерних узлов. | | [GetType](./gettype/)() const override | | | [HeaderFooter](./headerfooter/)(const System::SharedPtr\\&, Aspose::Words::HeaderFooterType) | Создаёт новый заголовок или нижний колонтитул указанного типа. | | [IndexOf](../compositenode/indexof/)(const System::SharedPtr\\&) | Возвращает индекс указанного дочернего узла в массиве дочерних узлов. | | [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\\&) | Получает следующий узел согласно алгоритму обхода дерева в порядке предобхода. | | static [NodeTypeToString](../node/nodetypetostring/)(Aspose::Words::NodeType) | Вспомогательный метод, преобразующий значение перечисления типа узла в удобочитаемую строку. | | [PrependChild](../compositenode/prependchild/)(T) | | | [PreviousPreOrder](../node/previouspreorder/)(const System::SharedPtr\\&) | Получает предыдущий узел согласно алгоритму обхода дерева в порядке предобхода. | | [Remove](../node/remove/)() | Удаляет себя из родительского узла. | | [RemoveAllChildren](../compositenode/removeallchildren/)() | Удаляет все дочерние узлы текущего узла. | | [RemoveChild](../compositenode/removechild/)(T) | | | [RemoveSmartTags](../compositenode/removesmarttags/)() | Удаляет все дочерние узлы [SmartTag](../../aspose.words.markup/smarttag/) текущего узла. | | [SelectNodes](../compositenode/selectnodes/)(const System::String\&) | Выбирает список узлов, соответствующих XPath-выражению. | | [SelectSingleNode](../compositenode/selectsinglenode/)(const System::String\&) | Выбирает первый [Node](../node/), который соответствует выражению XPath. | | [set_CustomNodeId](../node/set_customnodeid/)(int32_t) | Сеттер для [Aspose::Words::Node::get_CustomNodeId](../node/get_customnodeid/). | | [set_IsLinkedToPrevious](./set_islinkedtoprevious/)(bool) | Сеттер для [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\\&) | | | [SetTemplateWeakPtr](../compositenode/settemplateweakptr/)(uint32_t) override | | | [ToString](../node/tostring/)(Aspose::Words::SaveFormat) | Экспортирует содержимое узла в строку в указанном формате. | | [ToString](../node/tostring/)(const System::SharedPtr\\&) | Экспортирует содержимое узла в строку, используя указанные параметры сохранения. | | static [Type](./type/)() | | ## Примечания [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/). Если у [Section](../section/) нет [HeaderFooter](./) определённого типа или у [HeaderFooter](./) нет дочерних узлов, этот заголовок/нижний колонтитул считается связанным с заголовком/нижним колонтитулом того же типа в предыдущем разделе в Microsoft Word. Когда [HeaderFooter](./) содержит хотя бы один [Paragraph](../paragraph/), он больше не считается связанным с предыдущим в Microsoft Word. ## Примеры Показывает, как создать заголовок и нижний колонтитул. ```cpp auto doc = System::MakeObject(); // Создайте заголовок и добавьте к нему абзац. Текст в этом абзаце // будет отображаться в верхней части каждой страницы этого раздела, над основным текстом. auto header = System::MakeObject(doc, Aspose::Words::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()); // Создайте нижний колонтитул и добавьте к нему абзац. Текст в этом абзаце // будет отображаться в нижней части каждой страницы этого раздела, под основным текстом. auto footer = System::MakeObject(doc, Aspose::Words::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"); ``` Показывает, как удалить все нижние колонтитулы из документа. ```cpp auto doc = System::MakeObject(get_MyDir() + u"Header and footer types.docx"); // Пройдите по каждому разделу и удалите все типы нижних колонтитулов. for (auto&& section : System::IterateOver(doc->LINQ_OfType >())) { // Существует три типа нижних и верхних колонтитулов. // 1 - "First" заголовок/нижний колонтитул, который отображается только на первой странице раздела. System::SharedPtr footer = section->get_HeadersFooters()->idx_get(Aspose::Words::HeaderFooterType::FooterFirst); System::SharedPtr condExpression = footer; if (condExpression != nullptr) { condExpression->Remove(); } // 2 - "Primary" заголовок/нижний колонтитул, который отображается на нечётных страницах. footer = section->get_HeadersFooters()->idx_get(Aspose::Words::HeaderFooterType::FooterPrimary); System::SharedPtr condExpression2 = footer; if (condExpression2 != nullptr) { condExpression2->Remove(); } // 3 - "Even" заголовок/нижний колонтитул, который отображается на чётных страницах. footer = section->get_HeadersFooters()->idx_get(Aspose::Words::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"); ``` Показывает, как заменить текст в нижнем колонтитуле документа. ```cpp auto doc = System::MakeObject(get_MyDir() + u"Footer.docx"); System::SharedPtr headersFooters = doc->get_FirstSection()->get_HeadersFooters(); System::SharedPtr footer = headersFooters->idx_get(Aspose::Words::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"); ``` ## См. также * Class [Story](../story/) * Namespace [Aspose::Words](../) * Library [Aspose.Words for C++](../../)