Excel.HeaderFooter class

包:
excel
扩展
OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.9

使用方

属性

centerFooter

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

获取 HeaderFooterPicture 表示页脚中心部分图片的对象。
centerHeader

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

获取 HeaderFooterPicture 表示页眉中心部分图片的对象。
context

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

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

获取 HeaderFooterPicture 表示页脚左侧部分图片的对象。
leftHeader

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

获取表示 HeaderFooterPicture 标题左侧部分图片的对象。
rightFooter

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

获取表示 HeaderFooterPicture 页脚右侧部分图片的对象。
rightHeader

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

获取表示 HeaderFooterPicture 标题右侧部分图片的对象。

方法

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

centerFooterPicture

获取 HeaderFooterPicture 表示页脚中心部分图片的对象。

readonly centerFooterPicture: Excel.HeaderFooterPicture;

属性值

Excel.HeaderFooterPicture

注解

API 集：ExcelApiDesktop 1.1

centerHeader

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

centerHeader: string;

属性值

string

注解

API 集：ExcelApi 1.9

centerHeaderPicture

获取 HeaderFooterPicture 表示页眉中心部分图片的对象。

readonly centerHeaderPicture: Excel.HeaderFooterPicture;

属性值

Excel.HeaderFooterPicture

注解

API 集：ExcelApiDesktop 1.1

context

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

context: RequestContext;

属性值

Excel.RequestContext

leftFooter

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

leftFooter: string;

属性值

string

注解

API 集：ExcelApi 1.9

leftFooterPicture

获取 HeaderFooterPicture 表示页脚左侧部分图片的对象。

readonly leftFooterPicture: Excel.HeaderFooterPicture;

属性值

Excel.HeaderFooterPicture

注解

API 集：ExcelApiDesktop 1.1

leftHeader

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

leftHeader: string;

属性值

string

注解

API 集：ExcelApi 1.9

leftHeaderPicture

获取表示 HeaderFooterPicture 标题左侧部分图片的对象。

readonly leftHeaderPicture: Excel.HeaderFooterPicture;

属性值

Excel.HeaderFooterPicture

注解

API 集：ExcelApiDesktop 1.1

rightFooter

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

rightFooter: string;

属性值

string

注解

API 集：ExcelApi 1.9

rightFooterPicture

获取表示 HeaderFooterPicture 页脚右侧部分图片的对象。

readonly rightFooterPicture: Excel.HeaderFooterPicture;

属性值

Excel.HeaderFooterPicture

注解

API 集：ExcelApiDesktop 1.1

rightHeader

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

rightHeader: string;

属性值

string

注解

API 集：ExcelApi 1.9

rightHeaderPicture

获取表示 HeaderFooterPicture 标题右侧部分图片的对象。

readonly rightHeaderPicture: Excel.HeaderFooterPicture;

属性值

Excel.HeaderFooterPicture

注解

API 集：ExcelApiDesktop 1.1

方法详细信息

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