DocumentVisitorVisitHeaderFooterStart Method

public virtual VisitorAction VisitHeaderFooterStart(
	HeaderFooter headerFooter
)

Public Overridable Function VisitHeaderFooterStart ( 
	headerFooter As HeaderFooter
) As VisitorAction

public:
virtual VisitorAction VisitHeaderFooterStart(
	HeaderFooter^ headerFooter
)

abstract VisitHeaderFooterStart : 
        headerFooter : HeaderFooter -> VisitorAction 
override VisitHeaderFooterStart : 
        headerFooter : HeaderFooter -> VisitorAction 

public void HeaderFooterToText()
{
    // Open the document that has headers and/or footers we want to print the info of
    Document doc = new Document(MyDir + "DocumentVisitor-compatible features.docx");

    // Create an object that inherits from the DocumentVisitor class
    HeaderFooterInfoPrinter visitor = new HeaderFooterInfoPrinter();

    // Accepting a visitor lets it start traversing the nodes in the document, 
    // starting with the node that accepted it to then recursively visit every child
    doc.Accept(visitor);

    // Once the visiting is complete, we can retrieve the result of the operation,
    // that in this example, has accumulated in the visitor
    Console.WriteLine(visitor.GetText());

    // An alternative way of visiting a document's header/footers section-by-section is by accessing the collection
    // We can also turn it into an array
    HeaderFooter[] headerFooters = doc.FirstSection.HeadersFooters.ToArray();
    Assert.AreEqual(6, headerFooters.Length);
}

/// <summary>
/// This Visitor implementation prints information about HeaderFooter nodes encountered in the document.
/// </summary>
public class HeaderFooterInfoPrinter : DocumentVisitor
{
    public HeaderFooterInfoPrinter()
    {
        mBuilder = new StringBuilder();
        mVisitorIsInsideHeaderFooter = false;
    }

    /// <summary>
    /// Gets the plain text of the document that was accumulated by the visitor.
    /// </summary>
    public string GetText()
    {
        return mBuilder.ToString();
    }

    /// <summary>
    /// Called when a Run node is encountered in the document.
    /// </summary>
    public override VisitorAction VisitRun(Run run)
    {
        if (mVisitorIsInsideHeaderFooter) IndentAndAppendLine("[Run] \"" + run.GetText() + "\"");

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Called when a HeaderFooter node is encountered in the document.
    /// </summary>
    public override VisitorAction VisitHeaderFooterStart(HeaderFooter headerFooter)
    {
        IndentAndAppendLine("[HeaderFooter start] HeaderFooterType: " + headerFooter.HeaderFooterType);
        mDocTraversalDepth++;
        mVisitorIsInsideHeaderFooter = true;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Called when the visiting of a HeaderFooter node is ended.
    /// </summary>
    public override VisitorAction VisitHeaderFooterEnd(HeaderFooter headerFooter)
    {
        mDocTraversalDepth--;
        IndentAndAppendLine("[HeaderFooter end]");
        mVisitorIsInsideHeaderFooter = false;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Append a line to the StringBuilder and indent it depending on how deep the visitor is into the document tree.
    /// </summary>
    /// <param name="text"></param>
    private void IndentAndAppendLine(string text)
    {
        for (int i = 0; i < mDocTraversalDepth; i++) mBuilder.Append("|  ");

        mBuilder.AppendLine(text);
    }

    private bool mVisitorIsInsideHeaderFooter;
    private int mDocTraversalDepth;
    private readonly StringBuilder mBuilder;
}