Excel.HeaderFooter class

  • Reference
Package:
excel

Warning

This API is now deprecated.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

centerFooter

The center footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
centerHeader

The center header of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
context

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

The left footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
leftHeader

The left header of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
rightFooter

The right footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.
rightHeader

The right header of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.

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.HeaderFooter object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.HeaderFooterData) that contains shallow copies of any loaded child properties from the original object.

Property Details

centerFooter

Warning

This API is now deprecated.

The center footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.

centerFooter: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

centerHeader

The center header of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.

centerHeader: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

context

Warning

This API is now deprecated.

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

leftFooter

Warning

This API is now deprecated.

The left footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.

leftFooter: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

leftHeader

Warning

This API is now deprecated.

The left header of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.

leftHeader: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

rightFooter

Warning

This API is now deprecated.

The right footer of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.

rightFooter: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

rightHeader

Warning

This API is now deprecated.

The right header of the worksheet. To apply font formatting or insert a variable value, use format codes specified here: https://msdn.microsoft.com/library/bb225426.aspx.

rightHeader: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

Method Details

load(options)

Warning

This API is now deprecated.

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.HeaderFooterLoadOptions): Excel.HeaderFooter;

Parameters

options
Excel.Interfaces.HeaderFooterLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.HeaderFooter

load(propertyNames)

Warning

This API is now deprecated.

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.HeaderFooter;

Parameters

propertyNames

string | string[]

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

Returns

Excel.HeaderFooter

load(propertyNamesAndPaths)

Warning

This API is now deprecated.

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.HeaderFooter;

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.HeaderFooter

set(properties, options)

Warning

This API is now deprecated.

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.HeaderFooterUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Excel.Interfaces.HeaderFooterUpdateData

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)

Warning

This API is now deprecated.

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

set(properties: Excel.HeaderFooter): void;

Parameters

properties
Excel.HeaderFooter

Returns

void

toJSON()

Warning

This API is now deprecated.

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.HeaderFooter object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.HeaderFooterData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.HeaderFooterData;

Returns

Excel.Interfaces.HeaderFooterData