HeaderFooter

HeaderFooter class

Представляет контейнер для текста верхнего или нижнего колонтитула раздела.

Чтобы узнать больше, посетитеРабота с верхними и нижними колонтитулами документальная статья.

public class HeaderFooter : Story

Конструкторы

Имя	Описание
HeaderFooter(DocumentBase, HeaderFooterType)	Создает новый верхний или нижний колонтитул указанного типа.

Характеристики

Имя	Описание
Count { get; }	Получает количество непосредственных потомков этого узла.
CustomNodeId { get; set; }	Указывает пользовательский идентификатор узла.
virtual Document { get; }	Получает документ, к которому принадлежит этот узел.
FirstChild { get; }	Получает первый дочерний элемент узла.
FirstParagraph { get; }	Получает первый абзац в истории.
HasChildNodes { get; }	Возврат`истинный` если у этого узла есть дочерние узлы.
HeaderFooterType { get; }	Получает тип этого верхнего/нижнего колонтитула.
override IsComposite { get; }	Возврат`истинный` так как этот узел может иметь дочерние узлы.
IsHeader { get; }	Истина, если это`HeaderFooter` объект является заголовком.
IsLinkedToPrevious { get; set; }	Истина, если этот верхний или нижний колонтитул связан с соответствующим верхним или нижним колонтитулом в предыдущем разделе.
LastChild { get; }	Получает последний дочерний элемент узла.
LastParagraph { get; }	Получает последний абзац в истории.
NextSibling { get; }	Получает узел, следующий сразу за данным узлом.
override NodeType { get; }	ВозвратHeaderFooter .
Paragraphs { get; }	Получает коллекцию абзацев, которые являются непосредственными дочерними элементами истории.
ParentNode { get; }	Получает непосредственного родителя этого узла.
ParentSection { get; }	Получает родительский раздел этой истории.
PreviousSibling { get; }	Получает узел, непосредственно предшествующий данному узлу.
Range { get; }	Возвращает`Range`объект, представляющий часть документа, содержащуюся в этом узле.
StoryType { get; }	Получает тип этой истории.
Tables { get; }	Получает коллекцию таблиц, которые являются непосредственными дочерними элементами истории.

Методы

Имя	Описание
override Accept(DocumentVisitor)	Принимает посетителя.
override AcceptEnd(DocumentVisitor)	Принимает посетителя для посещения конца заголовка.
override AcceptStart(DocumentVisitor)	Принимает посетителя для посещения начала заголовка.
AppendChild<T>(T)	Добавляет указанный узел в конец списка дочерних узлов для данного узла.
AppendParagraph(string)	Метод быстрого доступа, который создает`Paragraph` объект с необязательным текстом и добавляет его в конец этого объекта.
Clone(bool)	Создает дубликат узла.
CreateNavigator()	Создает навигатор, который можно использовать для перемещения и чтения узлов.
DeleteShapes()	Удаляет все фигуры из текста этой истории.
GetAncestor(NodeType)	Получает первого предка указанного`NodeType` .
GetAncestor(Type)	Получает первого предка указанного типа объекта.
GetChild(NodeType, int, bool)	Возвращает N-й дочерний узел, соответствующий указанному типу.
GetChildNodes(NodeType, bool)	Возвращает живую коллекцию дочерних узлов, соответствующих указанному типу.
GetEnumerator()	Обеспечивает поддержку для каждой итерации стиля по дочерним узлам этого узла.
override GetText()	Получает текст этого узла и всех его дочерних узлов.
IndexOf(Node)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
InsertAfter<T>(T, Node)	Вставляет указанный узел сразу после указанного ссылочного узла.
InsertBefore<T>(T, Node)	Вставляет указанный узел непосредственно перед указанным ссылочным узлом.
NextPreOrder(Node)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
PrependChild<T>(T)	Добавляет указанный узел в начало списка дочерних узлов для данного узла.
PreviousPreOrder(Node)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
Remove()	Удаляет себя из родителя.
RemoveAllChildren()	Удаляет все дочерние узлы текущего узла.
RemoveChild<T>(T)	Удаляет указанный дочерний узел.
RemoveSmartTags()	Удаляет все`SmartTag` узлы-потомки текущего узла.
SelectNodes(string)	Выбирает список узлов, соответствующих выражению XPath.
SelectSingleNode(string)	Выбирает первый`Node` что соответствует выражению XPath.
ToString(SaveFormat)	Экспортирует содержимое узла в строку указанного формата.
ToString(SaveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Примечания

HeaderFooter может содержатьParagraph иСтол дочерние узлы.

HeaderFooter является узлом уровня раздела и может быть только дочерним узломSection . Может быть только одинHeaderFooter каждогоHeaderFooterType вSection.

ЕслиSection не имеетHeaderFooter определенного типа или HeaderFooter не имеет дочерних узлов, этот верхний/нижний колонтитул считается связанным с верхним/нижним колонтитулом того же типа предыдущего раздела в Microsoft Word.

КогдаHeaderFooter содержит по крайней мере одинParagraph, он больше не считается связанным с предыдущим в Microsoft Word.

Примеры

Показывает, как заменить текст в нижнем колонтитуле документа.

Document doc = new Document(MyDir + "Footer.docx");

HeaderFooterCollection headersFooters = doc.FirstSection.HeadersFooters;
HeaderFooter footer = headersFooters[HeaderFooterType.FooterPrimary];

FindReplaceOptions options = new FindReplaceOptions
{
    MatchCase = false,
    FindWholeWordsOnly = false
};

int currentYear = DateTime.Now.Year;
footer.Range.Replace("(C) 2006 Aspose Pty Ltd.", $"Copyright (C) {currentYear} by Aspose Pty Ltd.", options);

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

Показывает, как удалить все нижние колонтитулы из документа.

Document doc = new Document(MyDir + "Header and footer types.docx");

// Проходим по каждому разделу и удаляем нижние колонтитулы всех видов.
foreach (Section section in doc.OfType<Section>())
{
    // Существует три типа нижних и верхних колонтитулов.
    // 1 — «Первый» верхний/нижний колонтитул, который отображается только на первой странице раздела.
    HeaderFooter footer = section.HeadersFooters[HeaderFooterType.FooterFirst];
    footer?.Remove();

    // 2 — «Основной» верхний/нижний колонтитул, который отображается на нечетных страницах.
    footer = section.HeadersFooters[HeaderFooterType.FooterPrimary];
    footer?.Remove();

     // 3 - «Четный» верхний/нижний колонтитул, который отображается на четных страницах.
    footer = section.HeadersFooters[HeaderFooterType.FooterEven];
    footer?.Remove();

    Assert.AreEqual(0, section.HeadersFooters.Count(hf => !((HeaderFooter)hf).IsHeader));
}

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

Показывает, как создать верхний и нижний колонтитул.

Document doc = new Document();

// Создаем заголовок и добавляем к нему абзац. Текст в этом абзаце
// будет отображаться в верхней части каждой страницы этого раздела, над основным текстом.
HeaderFooter header = new HeaderFooter(doc, HeaderFooterType.HeaderPrimary);
doc.FirstSection.HeadersFooters.Add(header);

Paragraph para = header.AppendParagraph("My header.");

Assert.True(header.IsHeader);
Assert.True(para.IsEndOfHeaderFooter);

// Создаем нижний колонтитул и добавляем к нему абзац. Текст в этом абзаце
// будет отображаться внизу каждой страницы этого раздела, под основным текстом.
HeaderFooter footer = new HeaderFooter(doc, HeaderFooterType.FooterPrimary);
doc.FirstSection.HeadersFooters.Add(footer);

para = footer.AppendParagraph("My footer.");

Assert.False(footer.IsHeader);
Assert.True(para.IsEndOfHeaderFooter);

Assert.AreEqual(footer, para.ParentStory);
Assert.AreEqual(footer.ParentSection, para.ParentSection);
Assert.AreEqual(footer.ParentSection, header.ParentSection);

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

Смотрите также

class Story
пространство имен Aspose.Words
сборка Aspose.Words

FrameFormat Class HeaderFooterCollection Class