Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Excel.Interfaces.HeaderFooterGroupLoadOptions interface

Package:
excel

Remarks

API set: ExcelApi 1.9

Used by

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
defaultForAllPages

The general header/footer, used for all pages unless even/odd or first page is specified.
evenPages

The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.
firstPage

The first page header/footer, for all other pages general or even/odd is used.
oddPages

The header/footer to use for odd pages, even header/footer needs to be specified for even pages.
state

The state by which headers/footers are set. See Excel.HeaderFooterState for details.
useSheetMargins

Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
useSheetScale

Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

defaultForAllPages

The general header/footer, used for all pages unless even/odd or first page is specified.

defaultForAllPages?: Excel.Interfaces.HeaderFooterLoadOptions;

Property Value

Remarks

API set: ExcelApi 1.9

evenPages

The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.

evenPages?: Excel.Interfaces.HeaderFooterLoadOptions;

Property Value

Remarks

API set: ExcelApi 1.9

firstPage

The first page header/footer, for all other pages general or even/odd is used.

firstPage?: Excel.Interfaces.HeaderFooterLoadOptions;

Property Value

Remarks

API set: ExcelApi 1.9

oddPages

The header/footer to use for odd pages, even header/footer needs to be specified for even pages.

oddPages?: Excel.Interfaces.HeaderFooterLoadOptions;

Property Value

Remarks

API set: ExcelApi 1.9

state

The state by which headers/footers are set. See Excel.HeaderFooterState for details.

state?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

useSheetMargins

Specifies a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.

useSheetMargins?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

useSheetScale

Specifies a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.

useSheetScale?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

Feedback

Was this page helpful?