SheetHeaderFooter Class

Namespace:
GemBox.Spreadsheet
Assembly:
GemBox.Spreadsheet.dll

Represents sheet header/footer.

public sealed class SheetHeaderFooter
Public NotInheritable Class SheetHeaderFooter
Inheritance:
System.Object
SheetHeaderFooter

Constructors

SheetHeaderFooter()

SheetHeaderFooter constructor.

public SheetHeaderFooter()
Public Sub New

Properties

AlignWithMargins

Gets or sets if header/footer margin will align with page margins. Supported in XLSX and XLSB only.

public bool AlignWithMargins { get; set; }
Public Property AlignWithMargins As Boolean
Property Value
System.Boolean
Remarks

This value is currently ignored when exporting a document to PDF, XPS, or image formats.

DefaultPage

Gets or sets default header/footer.

public HeaderFooterPage DefaultPage { get; set; }
Public Property DefaultPage As HeaderFooterPage
Property Value
HeaderFooterPage

EvenPage

Gets or sets header/footer for even pages.

public HeaderFooterPage EvenPage { get; set; }
Public Property EvenPage As HeaderFooterPage
Property Value
HeaderFooterPage
Remarks

If HasEvenPage returns false, then DefaultPage will be used on even pages. This property is not supported when writing to XLS format.

FirstPage

Gets or sets first page header/footer.

public HeaderFooterPage FirstPage { get; set; }
Public Property FirstPage As HeaderFooterPage
Property Value
HeaderFooterPage
Remarks

If HasFirstPage returns false, then DefaultPage will be used on first page. This property is not supported when writing to XLS format.

HasEvenPage

Returns true if EvenPage header/footer is specified.

public bool HasEvenPage { get; }
Public ReadOnly Property HasEvenPage As Boolean
Property Value
System.Boolean
Remarks

If HasEvenPage returns false, then DefaultPage will be used on even pages.

HasFirstPage

Returns true if FirstPage header/footer is specified.

public bool HasFirstPage { get; }
Public ReadOnly Property HasFirstPage As Boolean
Property Value
System.Boolean
Remarks

If HasFirstPage returns false, then DefaultPage will be used on first page.

ScaleWithDoc

Gets or sets if headers/footers will be scaled with document scaling.

public bool ScaleWithDoc { get; set; }
Public Property ScaleWithDoc As Boolean
Property Value
System.Boolean