HeaderFooter

HeaderFooter class

Representerar en behållare för sidhuvudet eller sidfoten i ett avsnitt.

public class HeaderFooter : Story

Konstruktörer

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

Egenskaper

namn Beskrivning
ChildNodes { get; } Hämtar alla omedelbara underordnade noder för denna nod.
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; } Får det första barnet i noden.
FirstParagraph { get; } Får första stycket i berättelsen.
HasChildNodes { get; } Returnerar sant om denna nod har några underordnade noder.
HeaderFooterType { get; } Hämtar typen av denna sidhuvud/sidfot.
override IsComposite { get; } Returnerar sant eftersom denna nod kan ha underordnade noder.
IsHeader { get; } Sant om detta Sidhuvud objektet är en header.
IsLinkedToPrevious { get; set; } Sant om denna sidhuvud eller sidfot är länkad till motsvarande sidhuvud eller sidfot i föregående avsnitt.
LastChild { get; } Hämtar nodens sista underordnade.
LastParagraph { get; } Hämtar det sista stycket i berättelsen.
NextSibling { get; } Hämtar noden omedelbart efter denna nod.
override NodeType { get; } Returnerar NodeType.HeaderFooter .
Paragraphs { get; } Får en samling stycken som är omedelbara barn till berättelsen.
ParentNode { get; } Hämtar den omedelbara föräldern till denna nod.
ParentSection { get; } Hämtar den överordnade delen av denna berättelse.
PreviousSibling { get; } Hämtar noden omedelbart före denna nod.
Range { get; } Returnerar en Räckvidd objekt som representerar den del av ett dokument som finns i denna nod.
StoryType { get; } Hämtar typen av denna berättelse.
Tables { get; } Får en samling tabeller som är omedelbara barn till berättelsen.

Metoder

namn Beskrivning
override Accept(DocumentVisitor) Accepterar en besökare.
AppendChild(Node) Lägger till den angivna noden i slutet av listan över underordnade noder för denna nod.
AppendParagraph(string) En genvägsmetod som skapar enParagraph objekt med valfri text och lägger till den i slutet av detta objekt.
Clone(bool) Skapar en dubblett av noden.
CreateNavigator() Reserverad för systemanvändning. IXPathNavigable.
DeleteShapes() Tar bort alla former från texten i denna berättelse.
GetAncestor(NodeType) Hämtar den första förfadern till den angivnaNodeType .
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 aktiv samling av underordnade noder som matchar den angivna typen.
GetEnumerator() Tillhandahåller stöd för varje stiliteration över undernoderna för denna nod.
override GetText() Hämtar texten för denna nod och alla dess underordnade.
IndexOf(Node) Returnerar indexet för den angivna undernoden i den underordnade nodmatrisen.
InsertAfter(Node, Node) Infogar den angivna noden omedelbart efter den angivna referensnoden.
InsertBefore(Node, 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ädet.
PrependChild(Node) 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 förbeställningsträdet.
Remove() Tar bort sig själv från föräldern.
RemoveAllChildren() Tar bort alla undernoder för den aktuella noden.
RemoveChild(Node) Tar bort den angivna underordnade noden.
RemoveSmartTags() Tar bort allaSmartTag underliggande noder till den aktuella noden.
SelectNodes(string) Väljer en lista med noder som matchar XPath-uttrycket.
SelectSingleNode(string) Väljer den första noden som matchar XPath-uttrycket.
ToString(SaveFormat) Exporterar innehållet i noden till en sträng i angivet format.
ToString(SaveOptions) Exporterar innehållet i noden till en sträng med de angivna sparalternativen.

Anmärkningar

Sidhuvud kan innehålla Paragraf och Tabell barnnoder.

Sidhuvud är en nod på sektionsnivå och kan bara vara ett barn till Sektion . Det kan bara finnas en Sidhuvud eller var och enHeaderFooterType i en Sektion.

Om Sektion har inte en Sidhuvud av en specifik typ eller the Sidhuvud har inga underordnade noder, anses denna sidhuvud/sidfot vara länkad till sidhuvudet/sidfoten av samma typ av föregående avsnitt i Microsoft Word.

När Sidhuvud innehåller minst en Paragraf, anses det inte längre vara länkat till tidigare 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 sidfötter från ett dokument.

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

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

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

      // 3 - "Jämn" sidhuvudet/sidfoten, 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 till den. Texten i det stycket
// kommer att visas överst 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 till den. Texten i det stycket
// kommer att visas längst ned 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