| api_name | api_type | ms.assetid | title | description | ms.suite | ms.author | author | ms.topic | ms.date | ms.localizationpriority | ||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
22f973f4-58d1-4dd4-943e-a15ac2571b7c |
How to: Remove the headers and footers from a word processing document |
Learn how to remove the headers and footers from a word processing document using the Open XML SDK. |
office |
o365devx |
o365devx |
conceptual |
06/28/2021 |
medium |
This topic shows how to use the classes in the Open XML SDK for Office to programmatically remove all headers and footers in a word processing document. It contains an example RemoveHeadersAndFooters method to illustrate this task.
You can use the RemoveHeadersAndFooters method to remove all header and footer information from a word processing document. Be aware that you must not only delete the header and footer parts from the document storage, you must also delete the references to those parts from the document too. The sample code demonstrates both steps in the operation. The RemoveHeadersAndFooters method accepts a single parameter, a string that indicates the path of the file that you want to modify.
public static void RemoveHeadersAndFooters(string filename) Public Sub RemoveHeadersAndFooters(ByVal filename As String)The complete code listing for the method can be found in the Sample Code section.
To call the sample method, pass a string for the first parameter that contains the file name of the document that you want to modify as shown in the following code example.
RemoveHeadersAndFooters(@"C:\Users\Public\Documents\Headers.docx"); RemoveHeadersAndFooters("C:\Users\Public\Documents\Headers.docx")The RemoveHeadersAndFooters method works with the document you specify, deleting all of the header and footer parts and references to those parts. The code starts by opening the document, using the Open method and indicating that the document should be opened for read/write access (the final true parameter). Given the open document, the code uses the MainDocumentPart property to navigate to the main document, storing the reference in a variable named docPart.
// Given a document name, remove all of the headers and footers
// from the document.
using (WordprocessingDocument doc =
WordprocessingDocument.Open(filename, true))
{
// Code removed here...
} ' Given a document name, remove all of the headers and footers
' from the document.
Using doc = WordprocessingDocument.Open(filename, True)
' Code removed here...
End UsingGiven a reference to the document part, the code next determines if it has any work to do─that is, if the document contains any headers or footers. To decide, the code calls the Count method of both the HeaderParts and FooterParts properties of the document part, and if either returns a value greater than 0, the code continues. Be aware that the HeaderParts and FooterParts properties each return an IEnumerable of HeaderPart or FooterPart objects, respectively.
// Get a reference to the main document part.
var docPart = doc.MainDocumentPart;
// Count the header and footer parts and continue if there
// are any.
if (docPart.HeaderParts.Count() > 0 ||
docPart.FooterParts.Count() > 0)
{
// Code removed here...
} ' Get a reference to the main document part.
Dim docPart = doc.MainDocumentPart
' Count the header and footer parts and continue if there
' are any.
If (docPart.HeaderParts.Count > 0) Or
(docPart.FooterParts.Count > 0) Then
' Code removed here...
End IfGiven a collection of references to header and footer parts, you could write code to delete each one individually, but that is not necessary because of the Open XML SDK. Instead, you can call the DeleteParts<T> method, passing in the collection of parts to be deleted─this simple method provides a shortcut for deleting a collection of parts. Therefore, the following few lines of code take the place of the loop that you would otherwise have to write yourself.
// Remove the header and footer parts.
docPart.DeleteParts(docPart.HeaderParts);
docPart.DeleteParts(docPart.FooterParts); ' Remove the header and footer parts.
docPart.DeleteParts(docPart.HeaderParts)
docPart.DeleteParts(docPart.FooterParts)At this point, the code has deleted the header and footer parts, but the document still contains orphaned references to those parts. Before the orphaned references can be removed, the code must retrieve a reference to the content of the document (that is, to the XML content contained within the main document part). Later, after the changes are made, the code must ensure that they persist by explicitly saving them. Between these two operations, the code must delete the orphaned references, as shown in the section that follows the following code example.
// Get a reference to the root element of the main
// document part.
Document document = docPart.Document;
// Code removed here...
// Save the changes.
document.Save(); ' Get a reference to the root element of the main
' document part.
Dim document As Document = docPart.Document
' Code removed here...
' Save the changes.
document.Save()To remove the stranded references, the code first retrieves a collection of HeaderReference elements, converts the collection to a List, and then loops through the collection, calling the Remove method for each element found. Note that the code converts the IEnumerable returned by the Descendants method into a List so that it can delete items from the list, and that the HeaderReference type that is provided by the Open XML SDK makes it easy to refer to elements of type HeaderReference in the XML content. (Without that additional help, you would have to work with the details of the XML content directly.) Once it has removed all the headers, the code repeats the operation with the footer elements.
// Remove all references to the headers and footers.
// First, create a list of all descendants of type
// HeaderReference. Then, navigate the list and call
// Remove on each item to delete the reference.
var headers =
document.Descendants<HeaderReference>().ToList();
foreach (var header in headers)
{
header.Remove();
}
// First, create a list of all descendants of type
// FooterReference. Then, navigate the list and call
// Remove on each item to delete the reference.
var footers =
document.Descendants<FooterReference>().ToList();
foreach (var footer in footers)
{
footer.Remove();
} ' Remove all references to the headers and footers.
' First, create a list of all descendants of type
' HeaderReference. Then, navigate the list and call
' Remove on each item to delete the reference.
Dim headers = _
document.Descendants(Of HeaderReference).ToList()
For Each header In headers
header.Remove()
Next
' First, create a list of all descendants of type
' FooterReference. Then, navigate the list and call
' Remove on each item to delete the reference.
Dim footers = _
document.Descendants(Of FooterReference).ToList()
For Each footer In footers
footer.Remove()
NextThe following is the complete RemoveHeadersAndFooters code sample in C# and Visual Basic.