Excel.HeaderFooterGroup class
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| default |
常规页眉/页脚,除非指定偶数页/奇数页或首页,否则适用于所有页面, |
| even |
用于偶数页的页眉/页脚,需要为奇数页指定奇数页页眉/页脚。 |
| first |
首页的页眉/页脚,为所有其他页使用常规或偶数页/奇数页页眉/页脚。 |
| odd |
用于奇数页的页眉/页脚,需要为偶数页指定偶数页页眉/页脚。 |
| state | 设置页眉/页脚的状态。 有关详细信息,请参阅 |
| use |
指定一个标志,指示页眉/页脚是否与工作表的页面布局选项中设置的页边距对齐。 |
| use |
指定一个标志,指示是否应按工作表的页面布局选项中的页百分比缩放页眉/页脚缩放。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象,同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
defaultForAllPages
常规页眉/页脚,除非指定偶数页/奇数页或首页,否则适用于所有页面,
readonly defaultForAllPages: Excel.HeaderFooter;
属性值
注解
evenPages
用于偶数页的页眉/页脚,需要为奇数页指定奇数页页眉/页脚。
readonly evenPages: Excel.HeaderFooter;
属性值
注解
firstPage
首页的页眉/页脚,为所有其他页使用常规或偶数页/奇数页页眉/页脚。
readonly firstPage: Excel.HeaderFooter;
属性值
注解
oddPages
用于奇数页的页眉/页脚,需要为偶数页指定偶数页页眉/页脚。
readonly oddPages: Excel.HeaderFooter;
属性值
注解
state
设置页眉/页脚的状态。 有关详细信息,请参阅 Excel.HeaderFooterState。
state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";
属性值
Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"
注解
useSheetMargins
指定一个标志,指示页眉/页脚是否与工作表的页面布局选项中设置的页边距对齐。
useSheetMargins: boolean;
属性值
boolean
注解
useSheetScale
指定一个标志,指示是否应按工作表的页面布局选项中的页百分比缩放页眉/页脚缩放。
useSheetScale: boolean;
属性值
boolean
注解
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;
参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.HeaderFooterGroup;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.HeaderFooterGroup;
参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。
返回
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;