HeaderFooter

HeaderFooter class

Stellt einen Container für den Kopf- oder Fußzeilentext eines Abschnitts dar.

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

public class HeaderFooter : Story

Konstrukteure

Name	Beschreibung
HeaderFooter(DocumentBase, HeaderFooterType)	Erstellt eine neue Kopf- oder Fußzeile des angegebenen Typs.

Eigenschaften

Name	Beschreibung
Count { get; }	Ruft die Anzahl der unmittelbar untergeordneten Elemente dieses Knotens ab.
CustomNodeId { get; set; }	Gibt die benutzerdefinierte Knotenkennung an.
virtual Document { get; }	Ruft das Dokument ab, zu dem dieser Knoten gehört.
FirstChild { get; }	Ruft das erste untergeordnete Element des Knotens ab.
FirstParagraph { get; }	Ruft den ersten Absatz der Geschichte ab.
HasChildNodes { get; }	Rückgaben`WAHR` wenn dieser Knoten untergeordnete Knoten hat.
HeaderFooterType { get; }	Ruft den Typ dieser Kopf-/Fußzeile ab.
override IsComposite { get; }	Rückgaben`WAHR` da dieser Knoten untergeordnete Knoten haben kann.
IsHeader { get; }	Wahr, wenn dies`HeaderFooter` Objekt ist ein Header.
IsLinkedToPrevious { get; set; }	Wahr, wenn diese Kopf- oder Fußzeile mit der entsprechenden Kopf- oder Fußzeile im vorherigen Abschnitt verknüpft ist.
LastChild { get; }	Ruft das letzte untergeordnete Element des Knotens ab.
LastParagraph { get; }	Ruft den letzten Absatz der Geschichte ab.
NextSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar folgt.
override NodeType { get; }	RückgabenHeaderFooter .
Paragraphs { get; }	Ruft eine Sammlung von Absätzen ab, die unmittelbare untergeordnete Elemente der Story sind.
ParentNode { get; }	Ruft den unmittelbar übergeordneten Knoten dieses Knotens ab.
ParentSection { get; }	Ruft den übergeordneten Abschnitt dieser Story ab.
PreviousSibling { get; }	Ruft den Knoten ab, der diesem Knoten unmittelbar vorausgeht.
Range { get; }	Gibt einen`Range`Objekt, das den Teil eines Dokuments darstellt, der in diesem Knoten enthalten ist.
StoryType { get; }	Ruft den Typ dieser Story ab.
Tables { get; }	Ruft eine Sammlung von Tabellen ab, die unmittelbare untergeordnete Elemente der Story sind.

Methoden

Name	Beschreibung
override Accept(DocumentVisitor)	Nimmt einen Besucher auf.
override AcceptEnd(DocumentVisitor)	Akzeptiert einen Besucher für den Besuch des Endes der Kopfzeile.
override AcceptStart(DocumentVisitor)	Akzeptiert einen Besucher für den Besuch des Anfangs der Kopfzeile.
AppendChild<T>(T)	Fügt den angegebenen Knoten am Ende der Liste der untergeordneten Knoten für diesen Knoten hinzu.
AppendParagraph(string)	Eine Abkürzungsmethode, die eine`Paragraph` Objekt mit optionalem Text und hängt ihn an das Ende dieses Objekts an.
Clone(bool)	Erstellt ein Duplikat des Knotens.
CreateNavigator()	Erstellt einen Navigator, der zum Durchlaufen und Lesen von Knoten verwendet werden kann.
DeleteShapes()	Löscht alle Formen aus dem Text dieser Geschichte.
GetAncestor(NodeType)	Ruft den ersten Vorfahren des angegebenen`NodeType` .
GetAncestor(Type)	Ruft den ersten Vorgänger des angegebenen Objekttyps ab.
GetChild(NodeType, int, bool)	Gibt einen N-ten untergeordneten Knoten zurück, der dem angegebenen Typ entspricht.
GetChildNodes(NodeType, bool)	Gibt eine Live-Sammlung von untergeordneten Knoten zurück, die dem angegebenen Typ entsprechen.
GetEnumerator()	Bietet Unterstützung für die Iteration des For-Each-Stils über die untergeordneten Knoten dieses Knotens.
override GetText()	Ruft den Text dieses Knotens und aller seiner untergeordneten Knoten ab.
IndexOf(Node)	Gibt den Index des angegebenen untergeordneten Knotens im untergeordneten Knoten-Array zurück.
InsertAfter<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar nach dem angegebenen Referenzknoten ein.
InsertBefore<T>(T, Node)	Fügt den angegebenen Knoten unmittelbar vor dem angegebenen Referenzknoten ein.
NextPreOrder(Node)	Ruft den nächsten Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
PrependChild<T>(T)	Fügt den angegebenen Knoten am Anfang der Liste der untergeordneten Knoten für diesen Knoten hinzu.
PreviousPreOrder(Node)	Ruft den vorherigen Knoten gemäß dem Pre-Order-Tree-Traversal-Algorithmus ab.
Remove()	Entfernt sich selbst vom übergeordneten Element.
RemoveAllChildren()	Entfernt alle untergeordneten Knoten des aktuellen Knotens.
RemoveChild<T>(T)	Entfernt den angegebenen untergeordneten Knoten.
RemoveSmartTags()	Entfernt alle`SmartTag` Nachkommenknoten des aktuellen Knotens.
SelectNodes(string)	Wählt eine Liste von Knoten aus, die dem XPath-Ausdruck entsprechen.
SelectSingleNode(string)	Wählt den ersten`Node` das dem XPath-Ausdruck entspricht.
ToString(SaveFormat)	Exportiert den Inhalt des Knotens in eine Zeichenfolge im angegebenen Format.
ToString(SaveOptions)	Exportiert den Inhalt des Knotens unter Verwendung der angegebenen Speicheroptionen in eine Zeichenfolge.

Bemerkungen

HeaderFooter kann enthaltenParagraph UndTisch untergeordnete Knoten.

HeaderFooter ist ein Knoten auf Abschnittsebene und kann nur ein untergeordnetes Element vonSection . Es kann nur einen gebenHeaderFooter von jedemHeaderFooterType in einemSection.

WennSection hat keineHeaderFooter eines bestimmten Typs oder dieHeaderFooter keine untergeordneten Knoten hat, wird diese Kopf-/Fußzeile als verknüpft mit der Kopf-/Fußzeile desselben Typs des vorherigen Abschnitts in Microsoft Word betrachtet.

WannHeaderFooter enthält mindestens eineParagraph, wird es in Microsoft Word nicht mehr als mit dem vorherigen verknüpft betrachtet.

Beispiele

Zeigt, wie Text in der Fußzeile eines Dokuments ersetzt wird.

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

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

class Story
namensraum Aspose.Words
Montage Aspose.Words

FrameFormat Class HeaderFooterCollection Class