HeaderFooterCollection

HeaderFooterCollection class

Bietet typisierten Zugriff aufHeaderFooter Knoten einesSection .

Um mehr zu erfahren, besuchen Sie dieArbeiten mit Kopf- und Fußzeilen Dokumentationsartikel.

public class HeaderFooterCollection : NodeCollection

Eigenschaften

NameBeschreibung
Count { get; }Ruft die Anzahl der Knoten in der Sammlung ab.
Item { get; }Ruft eineHeaderFooter am angegebenen Index. (3 indexers)

Methoden

NameBeschreibung
Add(Node)Fügt am Ende der Sammlung einen Knoten hinzu.
Clear()Entfernt alle Knoten aus dieser Sammlung und aus dem Dokument.
Contains(Node)Bestimmt, ob ein Knoten in der Sammlung vorhanden ist.
GetEnumerator()Bietet eine einfache Iteration im „foreach“-Stil über die Knotensammlung.
IndexOf(Node)Gibt den nullbasierten Index des angegebenen Knotens zurück.
Insert(int, Node)Fügt einen Knoten am angegebenen Index in die Sammlung ein.
LinkToPrevious(bool)Verknüpft oder trennt alle Kopf- und Fußzeilen mit den entsprechenden Kopf- und Fußzeilen im vorherigen Abschnitt.
LinkToPrevious(HeaderFooterType, bool)Verknüpft die angegebene Kopf- oder Fußzeile mit der entsprechenden Kopf- oder Fußzeile im vorherigen Abschnitt oder hebt die Verknüpfung auf.
Remove(Node)Entfernt den Knoten aus der Sammlung und aus dem Dokument.
RemoveAt(int)Entfernt den Knoten am angegebenen Index aus der Sammlung und aus dem Dokument.
ToArray()Kopiert allesKopfzeileFußzeile s aus der Sammlung zu einer neuen Reihe vonKopfzeileFußzeile s. (2 methods)

Bemerkungen

Es kann maximal eineHeaderFooter

von jedemHeaderFooterType pro Section .

HeaderFooter Objekte können in beliebiger Reihenfolge in der Sammlung vorkommen.

Beispiele

Zeigt, wie alle Fußzeilen aus einem Dokument gelöscht werden.

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

// Durchlaufen Sie jeden Abschnitt und entfernen Sie Fußzeilen aller Art.
foreach (Section section in doc.OfType<Section>())
{
    // Es gibt drei Arten von Fußzeilen- und Kopfzeilentypen.
    // 1 – Die „Erste“ Kopf-/Fußzeile, die nur auf der ersten Seite eines Abschnitts angezeigt wird.
    HeaderFooter footer = section.HeadersFooters[HeaderFooterType.FooterFirst];
    footer?.Remove();

    // 2 – Die „primäre“ Kopf-/Fußzeile, die auf ungeraden Seiten erscheint.
    footer = section.HeadersFooters[HeaderFooterType.FooterPrimary];
    footer?.Remove();

        // 3 – Die Kopf-/Fußzeile „Gerade“, die auf geraden Seiten erscheint.
    footer = section.HeadersFooters[HeaderFooterType.FooterEven];
    footer?.Remove();

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

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

Zeigt, wie eine Kopf- und eine Fußzeile erstellt wird.

Document doc = new Document();

// Erstellen Sie eine Überschrift und fügen Sie einen Absatz hinzu. Der Text in diesem Absatz
// wird oben auf jeder Seite dieses Abschnitts über dem Haupttext angezeigt.
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);

// Erstellen Sie eine Fußzeile und fügen Sie einen Absatz hinzu. Der Text in diesem Absatz
// wird unten auf jeder Seite dieses Abschnitts unter dem Haupttext angezeigt.
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");

Siehe auch

HeaderFooter Class HeaderFooterType Enum