Excel.HeaderFooterPicture class
表示工作表的页眉或页脚中的图片。
注解
属性
| brightness | 指定图片的亮度。 此属性的值必须是介于 0.0 (最暗) 到 1.0 (最亮)。 |
| color |
指定图片的颜色转换类型。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| contrast | 指定图片的对比度。 此属性的值必须是从 0.0 (最低对比度) 到 1.0 (最大对比度) 的数字。 |
| crop |
指定从图片底部裁剪的点数。 |
| crop |
指定从图片左侧裁剪的点数。 |
| crop |
指定从图片右侧裁剪的点数。 |
| crop |
指定从图片顶部裁剪的点数。 |
| filename | 指定 intranet 或 Web) 或路径上的 URL (， (本地或网络) 源对象的保存位置。 |
| height | 指定图片的高度（以磅为单位）。 |
| lock |
指定一个值，该值指示图片在调整大小时是否保留其原始比例。
|
| width | 指定图片的宽度（以磅为单位）。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
brightness
指定图片的亮度。 此属性的值必须是介于 0.0 (最暗) 到 1.0 (最亮)。
brightness: number;属性值
number
注解
colorType
指定图片的颜色转换类型。
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";属性值
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
注解
context
contrast
指定图片的对比度。 此属性的值必须是从 0.0 (最低对比度) 到 1.0 (最大对比度) 的数字。
contrast: number;属性值
number
注解
cropBottom
cropLeft
cropRight
cropTop
filename
指定 intranet 或 Web) 或路径上的 URL (， (本地或网络) 源对象的保存位置。
filename: string;属性值
string
注解
height
lockAspectRatio
指定一个值，该值指示图片在调整大小时是否保留其原始比例。
true 如果保留其比例，则为 ;否则为 false。
lockAspectRatio: boolean;属性值
boolean
注解
width
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.HeaderFooterPicture;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.HeaderFooterPicture;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Excel.HeaderFooterPicture): void;参数
- properties
- Excel.HeaderFooterPicture
返回
void
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.HeaderFooterPicture对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.HeaderFooterPictureData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.HeaderFooterPictureData;