HeaderFooterCollection

HeaderFooterCollection class

Bietet typisierten Zugriff aufHeaderFooter Knoten von aSection .

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 a abHeaderFooter am angegebenen Index. (3 indexers)

Methoden

NameBeschreibung
Add(Node)Fügt einen Knoten am Ende der Sammlung hinzu.
Clear()Entfernt alle Knoten aus dieser Sammlung und aus dem Dokument.
Contains(Node)Bestimmt, ob ein Knoten in der Sammlung ist.
GetEnumerator()Bietet eine einfache Iteration im „foreach“-Stil über die Sammlung von Knoten.
IndexOf(Node)Gibt den nullbasierten Index des angegebenen Knotens zurück.
Insert(int, Node)Fügt am angegebenen Index einen Knoten in die Sammlung ein.
LinkToPrevious(bool)Verknüpft alle Kopf- und Fußzeilen mit den entsprechenden Kopf- und Fußzeilen im vorherigen Abschnitt oder hebt die Verknüpfung auf.
LinkToPrevious(HeaderFooterType, bool)Verknüpft oder hebt die Verknüpfung der angegebenen Kopf- oder Fußzeile mit der entsprechenden Kopf- oder Fußzeile im vorherigen Abschnitt 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 allesKopf- und Fußzeile s aus der Sammlung in ein neues Array vonKopf- und Fußzeile s. (2 methods)

Bemerkungen

Es kann maximal einer seinHeaderFooter

von jedemHeaderFooterType per 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");

// Jeden Abschnitt durchlaufen und Fußzeilen aller Art entfernen.
foreach (Section section in doc.OfType<Section>())
{
    // Es gibt drei Arten von Fuß- und Kopfzeilentypen.
    // 1 – Die „erste“ Kopf-/Fußzeile, die nur auf der ersten Seite eines Abschnitts erscheint.
    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 „gerade“ Kopf-/Fußzeile, 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 Fußzeile erstellt wird.

Document doc = new Document();

// Eine Überschrift erstellen und einen Absatz daran anhängen. 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);

// Eine Fußzeile erstellen und einen Absatz daran anhängen. 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