Excel.HeaderFooterGroup class

Package:

excel

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
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	Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.
useSheetScale	Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.HeaderFooterGroup object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.HeaderFooterGroupData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

defaultForAllPages

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

readonly defaultForAllPages: Excel.HeaderFooter;

Property Value

Excel.HeaderFooter

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.

readonly evenPages: Excel.HeaderFooter;

Property Value

Excel.HeaderFooter

Remarks

[ API set: ExcelApi 1.9 ]

firstPage

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

readonly firstPage: Excel.HeaderFooter;

Property Value

Excel.HeaderFooter

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.

readonly oddPages: Excel.HeaderFooter;

Property Value

Excel.HeaderFooter

Remarks

[ API set: ExcelApi 1.9 ]

state

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

state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";

Property Value

Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"

Remarks

[ API set: ExcelApi 1.9 ]

useSheetMargins

Gets or sets 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

Gets or sets 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 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;

Parameters

options

Excel.Interfaces.HeaderFooterGroupLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.HeaderFooterGroup

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.HeaderFooterGroup;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.HeaderFooterGroup

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.HeaderFooterGroup;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.HeaderFooterGroup

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.HeaderFooterGroupUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Excel.Interfaces.HeaderFooterGroupUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.HeaderFooterGroup): void;

Parameters

properties

Excel.HeaderFooterGroup

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.HeaderFooterGroup object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.HeaderFooterGroupData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.HeaderFooterGroupData;

Returns

Excel.Interfaces.HeaderFooterGroupData