Excel.HeaderFooter class
- Extends
Remarks
Properties
| center |
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. |
| center |
Gets a |
| center |
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. |
| center |
Gets a |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| left |
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. |
| left |
Gets a |
| left |
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. |
| left |
Gets a |
| right |
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. |
| right |
Gets a |
| right |
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. |
| right |
Gets a |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| 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 |
Property Details
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.
centerFooter: string;Property Value
string
Remarks
centerFooterPicture
Gets a HeaderFooterPicture object that represents the picture for the center section of the footer.
readonly centerFooterPicture: Excel.HeaderFooterPicture;Property Value
Remarks
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
centerHeaderPicture
Gets a HeaderFooterPicture object that represents the picture for the center section of the header.
readonly centerHeaderPicture: Excel.HeaderFooterPicture;Property Value
Remarks
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
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.
leftFooter: string;Property Value
string
Remarks
leftFooterPicture
Gets a HeaderFooterPicture object that represents the picture for the left section of the footer.
readonly leftFooterPicture: Excel.HeaderFooterPicture;Property Value
Remarks
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.
leftHeader: string;Property Value
string
Remarks
leftHeaderPicture
Gets a HeaderFooterPicture object that represents the picture for the left section of the header.
readonly leftHeaderPicture: Excel.HeaderFooterPicture;Property Value
Remarks
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.
rightFooter: string;Property Value
string
Remarks
rightFooterPicture
Gets a HeaderFooterPicture object that represents the picture for the right section of the footer.
readonly rightFooterPicture: Excel.HeaderFooterPicture;Property Value
Remarks
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.
rightHeader: string;Property Value
string
Remarks
rightHeaderPicture
Gets a HeaderFooterPicture object that represents the picture for the right section of the header.
readonly rightHeaderPicture: Excel.HeaderFooterPicture;Property Value
Remarks
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.HeaderFooterLoadOptions): Excel.HeaderFooter;Parameters
Provides options for which properties of the object to load.
Returns
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.HeaderFooter;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
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.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
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.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)
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()
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's 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;