Header and Footer

This page has moved. The current version of this page is at https://epplussoftware.com/docs/worksheet-and-ranges/worksheets/header-and-footer/. The EPPlus documentation is no longer updated in this wiki; please use the EPPlus guides and update your bookmarks.

Headers and Footers of printed worksheets are set via the ExcelWorksheet.HeaderFooter property.

If you want the same header on all pages when printing the worksheet, use the ExcelWorksheet.HeaderFooter.OddHeader property only:

using(var package = new ExcelPackage())
{
   var sheet = package.Workbook.Worksheets.Add("Sheet1");
   // add a logo to upper left corner
   using(var fs = new FileStream(@"c:\images\myLogo.jpg", FileMode.Open))
   {
      var drawing = sheet.HeaderFooter.OddHeader.InsertPicture(fs, ePictureType.Jpg, PictureAlignment.Left);
      // you can use the drawing instance to change Height, Width, etc.
   }
   // add todays date to the upper right corner
   sheet.HeaderFooter.OddHeader.RightAlignedText = ExcelHeaderFooter.CurrentDate;
}

When setting values for both ExcelWorksheet.HeaderFooter.OddHeader and ExcelWorksheet.HeaderFooter.EvenHeader, these will be used on every second page respectively, starting with OddHeader. See example below:

// for odd page numbers - add an image in the upper left corner
using var fs1 = new FileStream(imgPath1, FileMode.Open);
sheet.HeaderFooter.OddHeader.InsertPicture(fs1, ePictureType.Jpg, PictureAlignment.Left);

// for even page numbers - add an image in the upper right corner
using var fs2 = new FileStream(imgPath2, FileMode.Open);
sheet.HeaderFooter.EvenHeader.InsertPicture(fs2, ePictureType.Jpg, PictureAlignment.Right);

sheet.HeaderFooter.OddHeader.RightAlignedText = ExcelHeaderFooter.CurrentDate;
sheet.HeaderFooter.EvenHeader.LeftAlignedText = ExcelHeaderFooter.CurrentDate;

As demonstrated in the examples above you can insert various values by using static constants from the ExcelHeaderFooter class. See table below:

Works as headers (see above), but use ExcelWorksheet.HeaderFooter.OddFooter and ExcelWorksheet.HeaderFooter.EvenFooter instead.

As of EPPlus 8.1 you can now handle HeaderFooter text as a list of objects with properties just like Rich text. This is an addition to the current system and is compatible with the current way you work with Headers and Footers in EPPlus.

The HeaderFooter object in the worksheet now has 3 new properties: LeftAligned, Centered, and RightAligned. Each contains a collection of ExcelHeaderFooterTextItems that contains the text and its properties. You can also add or insert pictures, page numbers, dates, and so on using the collection.

Example of how to add a footer with text and page number:

worksheet.HeaderFooter.OddFooter.LeftAligned.AddText("Page: ");
worksheet.HeaderFooter.OddFooter.LeftAligned.AddPageNumber();

Example of how to change font and size:

var text = worksheet.HeaderFooter.OddHeader.RightAligned.AddText("My Document");
text.FontSize = 24;
text.FontName = "Arial";

Example of how to insert a picture using a FileInfo:

FileInfo myPicture = new FileInfo("myPicture.png");
var text = worksheet.HeaderFooter.OddHeader.RightAligned.AddPicture(myPicture);

• Sample 1.1-C# and sample 1.1-VB have more examples on how to add headers/footers.