Excel.Interfaces.HeaderFooterLoadOptions interface

Warning

This API is now deprecated.

Remarks

[ API set: ExcelApi 1.9 ]

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

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.

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.

Property Details

$all

Warning

This API is now deprecated.

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

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

centerHeader

Warning

This API is now deprecated.

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]