Interface IHeaderFooter

Common interface for

Namespace: IronXL.Layout
Assembly: IronXL.dll
Syntax
public interface IHeaderFooter

IHeaderFooter is the shared contract for the running header and footer text printed on every page of a worksheet. A developer assigns the three positioned text zones, left, center, and right, to put a report title, a page number, or a company name across the top or bottom of a printed sheet. It is the common base that both the page header and the page footer expose, so the same three properties drive both, and a developer rarely names IHeaderFooter directly, instead working through the header or footer a worksheet hands back.

A developer reaches it through the worksheet: WorkSheet.Header returns an IHeader and WorkSheet.Footer returns an IFooter, both of which extend IHeaderFooter and add no members of their own. The two derived contracts exist only to distinguish which zone of the page is being addressed; the editable surface is identical. The Left, Center, and Right properties are each a readable and writable string holding the text for that zone. Set the ones a layout needs, leave the rest empty, and save the workbook to apply them to print output.

IHeaderFooter header = sheet.Header;
header.Center = "Quarterly Report";
header.Right = "Page &P";

The Excel print setup example configures a sheet for printing, where header and footer text appear on each page, and the WorkSheet reference documents the Header and Footer properties that return them.

Properties

Center

Gets or sets the center of the header or footer.

Declaration
string Center { get; set; }
Property Value
Type Description
System.String

The string representing the center.

Left

Gets or sets the left side of the header or footer.

Declaration
string Left { get; set; }
Property Value
Type Description
System.String

The string representing the left side.

Right

Gets or sets the right side of the header or footer.

Declaration
string Right { get; set; }
Property Value
Type Description
System.String

The string representing the right side.