Excel.DocumentProperties class

  • 参考
包:
excel

表示工作簿属性。

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.7 ]

属性

author

工作簿的作者。
category

工作簿的类别。
comments

工作簿的注释。
company

工作簿的公司。
context

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

获取工作簿的创建日期。
custom

获取工作簿的自定义属性的集合。
keywords

工作簿的关键字。
lastAuthor

获取工作簿的最终作者。
manager

工作簿的经理。
revisionNumber

获取工作簿的修订号。
subject

工作簿的主题。
title

工作簿的标题。

方法

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

属性详细信息

author

工作簿的作者。

author: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

category

工作簿的类别。

category: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

comments

工作簿的注释。

comments: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

company

工作簿的公司。

company: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

creationDate

获取工作簿的创建日期。

readonly creationDate: Date;

属性值

Date

注解

[ API 集：ExcelApi 1.7 ]

custom

获取工作簿的自定义属性的集合。

readonly custom: Excel.CustomPropertyCollection;

属性值

Excel.CustomPropertyCollection

注解

[ API 集：ExcelApi 1.7 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml

await Excel.run(async (context) => {
  // Load the keys and values of all custom properties.
  const customDocProperties = context.workbook.properties.custom;
  customDocProperties.load(["key", "value"]);
  await context.sync();

  // Log each custom property to the console.
  // Note that your document may have more properties than those you have set using this snippet.
  customDocProperties.items.forEach((property) => {
    console.log(`${property.key}:${property.value}`);
  });
});

keywords

工作簿的关键字。

keywords: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

lastAuthor

获取工作簿的最终作者。

readonly lastAuthor: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

manager

工作簿的经理。

manager: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

revisionNumber

获取工作簿的修订号。

revisionNumber: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

subject

工作簿的主题。

subject: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

title

工作簿的标题。

title: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.DocumentPropertiesLoadOptions): Excel.DocumentProperties;

参数

options
Excel.Interfaces.DocumentPropertiesLoadOptions

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

返回

Excel.DocumentProperties

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.DocumentProperties

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.DocumentProperties

set(properties, options)

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

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

参数

properties
Excel.Interfaces.DocumentPropertiesUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.DocumentProperties): void;

参数

properties
Excel.DocumentProperties

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.DocumentPropertiesData;

返回

Excel.Interfaces.DocumentPropertiesData