Excel.HeaderFooter class

  • 参考
包:
excel
Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

centerFooter

工作表的中心页脚。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。
centerHeader

工作表的中心标题。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。
context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
leftFooter

工作表的左脚。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。
leftHeader

工作表的左标题。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。
rightFooter

工作表的右页脚。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。
rightHeader

工作表的右标题。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。

方法

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)

基于现有的已加载对象，同时对对象设置多个属性。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 Excel.HeaderFooter 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.HeaderFooterData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

centerFooter

工作表的中心页脚。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。

centerFooter: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

centerHeader

工作表的中心标题。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。

centerHeader: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

leftFooter

工作表的左脚。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。

leftFooter: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

leftHeader

工作表的左标题。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。

leftHeader: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

rightFooter

工作表的右页脚。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。

rightFooter: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

rightHeader

工作表的右标题。 若要应用字体格式或插入变量值，请使用此处指定的格式代码： https://msdn.microsoft.com/library/bb225426.aspx。

rightHeader: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter;

参数

options
Excel.Interfaces.HeaderFooterLoadOptions

提供要加载对象的属性的选项。

返回

Excel.HeaderFooter

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.HeaderFooter

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.HeaderFooter

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

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

参数

properties
Excel.Interfaces.HeaderFooterUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.HeaderFooter): void;

参数

properties
Excel.HeaderFooter

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始 Excel.HeaderFooter 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.HeaderFooterData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.HeaderFooterData;

返回

Excel.Interfaces.HeaderFooterData