HeaderFooter

HeaderFooter class

Representerar en behållare för sidhuvud- eller sidfotstexten i ett avsnitt.

För att lära dig mer, besökArbeta med sidhuvuden och sidfot dokumentationsartikel.

public class HeaderFooter : Story

Konstruktörer

namn	Beskrivning
HeaderFooter(DocumentBase, HeaderFooterType)	Skapar ett nytt sidhuvud eller en ny sidfot av den angivna typen.

Egenskaper

namn	Beskrivning
Count { get; }	Hämtar antalet omedelbara barn till denna nod.
CustomNodeId { get; set; }	Anger anpassad nodidentifierare.
virtual Document { get; }	Hämtar dokumentet som denna nod tillhör.
FirstChild { get; }	Hämtar nodens första barn.
FirstParagraph { get; }	Hämtar det första stycket i berättelsen.
HasChildNodes { get; }	Returer`sann` om den här noden har några undernoder.
HeaderFooterType { get; }	Hämtar typen av detta sidhuvud/sidfot.
override IsComposite { get; }	Returer`sann` eftersom denna nod kan ha underordnade noder.
IsHeader { get; }	Sant om detta`HeaderFooter` objektet är en rubrik.
IsLinkedToPrevious { get; set; }	Sant om detta sidhuvud eller sidfot är länkat till motsvarande sidhuvud eller sidfot i föregående avsnitt.
LastChild { get; }	Hämtar nodens sista barn.
LastParagraph { get; }	Hämtar det sista stycket i berättelsen.
NextSibling { get; }	Hämtar noden som följer direkt efter denna nod.
override NodeType { get; }	ReturerHeaderFooter .
Paragraphs { get; }	Hämtar en samling stycken som är direkta underordnade stycken till berättelsen.
ParentNode { get; }	Hämtar den omedelbara föräldern till denna nod.
ParentSection { get; }	Hämtar huvudavsnittet för den här artikeln.
PreviousSibling { get; }	Hämtar noden som omedelbart föregår denna nod.
Range { get; }	Returnerar en`Range`objekt som representerar den del av ett dokument som finns i denna nod.
StoryType { get; }	Hämtar typen av den här berättelsen.
Tables { get; }	Hämtar en samling tabeller som är direkta underordnade tabeller till berättelsen.

Metoder

namn	Beskrivning
override Accept(DocumentVisitor)	Tar emot en besökare.
override AcceptEnd(DocumentVisitor)	Accepterar en besökare för att besöka slutet av rubriken.
override AcceptStart(DocumentVisitor)	Accepterar en besökare för att besöka början av rubriken.
AppendChild<T>(T)	Lägger till den angivna noden i slutet av listan över underordnade noder för denna nod.
AppendParagraph(string)	En genvägsmetod som skapar en`Paragraph` objekt med valfri text och lägger till den i slutet av detta objekt.
Clone(bool)	Skapar en duplikat av noden.
CreateNavigator()	Skapar en navigator som kan användas för att korsa och läsa noder.
DeleteShapes()	Tar bort alla former från texten i den här berättelsen.
GetAncestor(NodeType)	Hämtar den första förfadern till den angivna`NodeType` .
GetAncestor(Type)	Hämtar den första förfadern till den angivna objekttypen.
GetChild(NodeType, int, bool)	Returnerar en N:te underordnad nod som matchar den angivna typen.
GetChildNodes(NodeType, bool)	Returnerar en live-samling av underordnade noder som matchar den angivna typen.
GetEnumerator()	Ger stöd för iterationen för varje stil över de underordnade noderna till denna nod.
override GetText()	Hämtar texten för denna nod och alla dess underordnade noder.
IndexOf(Node)	Returnerar indexet för den angivna undernoden i undernodsmatrisen.
InsertAfter<T>(T, Node)	Infogar den angivna noden omedelbart efter den angivna referensnoden.
InsertBefore<T>(T, Node)	Infogar den angivna noden omedelbart före den angivna referensnoden.
NextPreOrder(Node)	Hämtar nästa nod enligt algoritmen för förbeställningsträdtraversering.
PrependChild<T>(T)	Lägger till den angivna noden i början av listan över underordnade noder för denna nod.
PreviousPreOrder(Node)	Hämtar föregående nod enligt algoritmen för trädtraversering i förbeställning.
Remove()	Tar bort sig själv från föräldern.
RemoveAllChildren()	Tar bort alla undernoder till den aktuella noden.
RemoveChild<T>(T)	Tar bort den angivna undernoden.
RemoveSmartTags()	Tar bort alla`SmartTag` underordnade noder till den aktuella noden.
SelectNodes(string)	Väljer en lista med noder som matchar XPath-uttrycket.
SelectSingleNode(string)	Väljer den första`Node` som matchar XPath-uttrycket.
ToString(SaveFormat)	Exporterar nodens innehåll till en sträng i det angivna formatet.
ToString(SaveOptions)	Exporterar nodens innehåll till en sträng med de angivna sparalternativen.

Anmärkningar

HeaderFooter kan innehållaParagraph ochTabell underordnade noder.

HeaderFooter är en nod på sektionsnivå och kan bara vara underordnadSection . Det kan bara finnas enHeaderFooter av varjeHeaderFooterType i enSection.

OmSection har inte enHeaderFooter av en specifik typ eller HeaderFooter inte har några underordnade noder anses denna sidhuvud/sidfot vara länkad till sidhuvudet/sidfoten av samma typ som föregående avsnitt i Microsoft Word.

NärHeaderFooter innehåller minst enParagraph, anses den inte längre vara länkad till föregående i Microsoft Word.

Exempel

Visar hur man ersätter text i ett dokuments sidfot.

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");

Visar hur man tar bort alla sidfot från ett dokument.

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

// Gå igenom varje avsnitt och ta bort sidfot av alla slag.
foreach (Section section in doc.OfType<Section>())
{
    // Det finns tre typer av sidfot och sidhuvud.
    // 1 - Sidhuvudet/sidfoten "Första", som bara visas på första sidan i ett avsnitt.
    HeaderFooter footer = section.HeadersFooters[HeaderFooterType.FooterFirst];
    footer?.Remove();

    // 2 - Sidhuvudet/sidfoten "Primärt", som visas på udda sidor.
    footer = section.HeadersFooters[HeaderFooterType.FooterPrimary];
    footer?.Remove();

     // 3 - Sidhuvudet/sidfoten "Jämnt", som visas på jämna sidor.
    footer = section.HeadersFooters[HeaderFooterType.FooterEven];
    footer?.Remove();

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

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

Visar hur man skapar ett sidhuvud och en sidfot.

Document doc = new Document();

// Skapa en rubrik och lägg till ett stycke i den. Texten i det stycket
// kommer att visas högst upp på varje sida i det här avsnittet, ovanför huvudtexten.
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);

// Skapa en sidfot och lägg till ett stycke i den. Texten i det stycket
// kommer att visas längst ner på varje sida i det här avsnittet, under huvudtexten.
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");

Se även

class Story
namnutrymme Aspose.Words
hopsättning Aspose.Words

FrameFormat Class HeaderFooterCollection Class