Excel.HeaderFooterGroup class

包:
excel
扩展
OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.9

使用方

属性

context

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

常规页眉/页脚，除非指定偶数页/奇数页或首页，否则适用于所有页面，
evenPages

用于偶数页的页眉/页脚，需要为奇数页指定奇数页页眉/页脚。
firstPage

首页的页眉/页脚，为所有其他页使用常规或偶数页/奇数页页眉/页脚。
oddPages

用于奇数页的页眉/页脚，需要为偶数页指定偶数页页眉/页脚。
state

设置页眉/页脚时所用的状态。 有关详细信息，请参阅 Excel.HeaderFooterState。
useSheetMargins

指定一个标志，指示页眉/页脚是否与工作表的页面布局选项中设置的页边距对齐。
useSheetScale

指定一个标志，指示页眉/页脚是否应按工作表页面布局选项中设置的页面百分比缩放。

方法

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.HeaderFooterGroup 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.HeaderFooterGroupData) ，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

defaultForAllPages

常规页眉/页脚，除非指定偶数页/奇数页或首页，否则适用于所有页面，

readonly defaultForAllPages: Excel.HeaderFooter;

属性值

Excel.HeaderFooter

注解

API 集：ExcelApi 1.9

evenPages

用于偶数页的页眉/页脚，需要为奇数页指定奇数页页眉/页脚。

readonly evenPages: Excel.HeaderFooter;

属性值

Excel.HeaderFooter

注解

API 集：ExcelApi 1.9

firstPage

首页的页眉/页脚，为所有其他页使用常规或偶数页/奇数页页眉/页脚。

readonly firstPage: Excel.HeaderFooter;

属性值

Excel.HeaderFooter

注解

API 集：ExcelApi 1.9

oddPages

用于奇数页的页眉/页脚，需要为偶数页指定偶数页页眉/页脚。

readonly oddPages: Excel.HeaderFooter;

属性值

Excel.HeaderFooter

注解

API 集：ExcelApi 1.9

state

设置页眉/页脚时所用的状态。 有关详细信息，请参阅 Excel.HeaderFooterState。

state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";

属性值

Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"

注解

API 集：ExcelApi 1.9

useSheetMargins

指定一个标志，指示页眉/页脚是否与工作表的页面布局选项中设置的页边距对齐。

useSheetMargins: boolean;

属性值

boolean

注解

API 集：ExcelApi 1.9

useSheetScale

指定一个标志，指示页眉/页脚是否应按工作表页面布局选项中设置的页面百分比缩放。

useSheetScale: boolean;

属性值

boolean

注解

API 集：ExcelApi 1.9

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;

参数

options
Excel.Interfaces.HeaderFooterGroupLoadOptions

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

返回

Excel.HeaderFooterGroup

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.HeaderFooterGroup

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.HeaderFooterGroup

set(properties, options)

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

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

参数

properties
Excel.Interfaces.HeaderFooterGroupUpdateData

一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.HeaderFooterGroup): void;

参数

properties
Excel.HeaderFooterGroup

返回

void

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.HeaderFooterGroup 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.HeaderFooterGroupData) ，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Excel.Interfaces.HeaderFooterGroupData;

返回

Excel.Interfaces.HeaderFooterGroupData