Back to Devexpress

WorksheetHeaderFooterOptions Interface

officefileapi-devexpress-dot-spreadsheet-4bcfe0c2.md

latest4.3 KB
Original Source

WorksheetHeaderFooterOptions Interface

Allows you to specify headers and footers for a worksheet or chart sheet.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
public interface WorksheetHeaderFooterOptions
vb
Public Interface WorksheetHeaderFooterOptions

The following members return WorksheetHeaderFooterOptions objects:

Remarks

Use the WorksheetHeaderFooterOptions object’s properties to add headers and footers to printed pages.

PropertiesDescription
WorksheetHeaderFooterOptions.DifferentFirstSpecifies whether the first page has a unique header and footer.
WorksheetHeaderFooterOptions.FirstHeader
WorksheetHeaderFooterOptions.FirstFooterDefine a header and footer for the first page.
WorksheetHeaderFooterOptions.DifferentOddEvenSpecifies whether odd and even pages have different headers and footers.
WorksheetHeaderFooterOptions.OddHeader
WorksheetHeaderFooterOptions.OddFooterDefine headers and footers for odd pages.
WorksheetHeaderFooterOptions.EvenHeader
WorksheetHeaderFooterOptions.EvenFooterDefine headers and footers for even pages.

The following example shows how to specify the header and footer for the first page.

csharp
WorksheetHeaderFooterOptions options = worksheet.HeaderFooterOptions;

// Specify that the first page has a unique header and footer.
options.DifferentFirst = true;

// Insert the rich formatted text into the header's left section.
options.FirstHeader.Left = string.Format("{0}&BDev{1}AV", HeaderFooterCode.FontColor(4, -50), HeaderFooterCode.FontColor(4,10));

// Insert the sheet name into the header's right section.
options.FirstHeader.Right = "&A";

// Insert the current date into the footer's left section.
options.FirstFooter.Left = "&D";

// Insert the current page number into the footer's right section.
options.FirstFooter.Right = string.Format("Page {0} of {1}", "&P", "&N");
vb
Dim options As WorksheetHeaderFooterOptions = worksheet.HeaderFooterOptions

' Specify that the first page has a unique header and footer. 
options.DifferentFirst = True

' Insert the rich formatted text into the header's left section.
options.FirstHeader.Left = String.Format("{0}&BDev{1}AV", HeaderFooterCode.FontColor(4, -50), HeaderFooterCode.FontColor(4,10))

' Insert the sheet name into the header's right section.
options.FirstHeader.Right = "&A"

' Insert the current date into the footer's left section.
options.FirstFooter.Left = "&D"

' Insert the current page number into the footer's right section.
options.FirstFooter.Right = String.Format("Page {0} of {1}", "&P", "&N")

See Also

WorksheetHeaderFooterOptions Members

HeaderFooterCode

DevExpress.Spreadsheet Namespace