Word.DocumentProperties class
表示文档属性。
注解
使用方
- Word.文档： builtInDocumentProperties， customDocumentProperties， properties
- Word.DocumentCreated： properties
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml
await Word.run(async (context) => {
const builtInProperties: Word.DocumentProperties = context.document.properties;
builtInProperties.load("*"); // Let's get all!
await context.sync();
console.log(JSON.stringify(builtInProperties, null, 4));
});
属性
| application |
获取 document 的应用程序名称。 |
| author | 指定文档的作者。 |
| category | 指定文档的类别。 |
| comments | 指定文档元数据中的“批注”字段。 这些与用户在文档中所做的评论无关。 |
| company | 指定文档的公司。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| creation |
获取文档的创建日期。 |
| custom |
获取 document 的一组 customProperty。 |
| format | 指定文档的格式。 |
| keywords | 指定文档的关键字。 |
| last |
获取文档的最后一位作者。 |
| last |
获取文档的上次打印日期。 |
| last |
获取 document 的上次保存日期。 |
| manager | 指定文档的管理员。 |
| revision |
获取文档的修订号。 |
| security | 获取文档的安全设置。 有些是对磁盘上文件的访问限制。 其他为文档保护设置。 一些可能的值为 0 = 磁盘上的文件是读/写;1 = 保护文档：文件已加密，需要密码才能打开;2 = 保护文档：始终以只读方式打开;3 = 保护文档：#1 和 #2;4 = 磁盘上的文件是只读的;5 = #1 和 #4;6 = #2 和 #4;7 = #1、#2 和 #4 的所有;8 = 保护文档：将编辑限制为只读;9 = #1 和 #8;10 = #2 和 #8;11 = #1、#2 和 #8 的所有;12 = #4 和 #8;13 = #1、#4 和 #8 的所有;14 = #2、#4 和 #8 的所有;15 = #1、#2、#4 和 #8 的所有函数。 |
| subject | 指定文档的主题。 |
| template | 获取文档的模板。 |
| title | 指定文档的标题。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
applicationName
author
category
comments
company
context
creationDate
customProperties
获取 document 的一组 customProperty。
readonly customProperties: Word.CustomPropertyCollection;属性值
注解
format
keywords
lastAuthor
lastPrintDate
lastSaveTime
manager
revisionNumber
security
获取文档的安全设置。 有些是对磁盘上文件的访问限制。 其他为文档保护设置。 一些可能的值为 0 = 磁盘上的文件是读/写;1 = 保护文档：文件已加密，需要密码才能打开;2 = 保护文档：始终以只读方式打开;3 = 保护文档：#1 和 #2;4 = 磁盘上的文件是只读的;5 = #1 和 #4;6 = #2 和 #4;7 = #1、#2 和 #4 的所有;8 = 保护文档：将编辑限制为只读;9 = #1 和 #8;10 = #2 和 #8;11 = #1、#2 和 #8 的所有;12 = #4 和 #8;13 = #1、#4 和 #8 的所有;14 = #2、#4 和 #8 的所有;15 = #1、#2、#4 和 #8 的所有函数。
readonly security: number;属性值
number
注解
subject
template
title
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.DocumentProperties;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.DocumentProperties;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.DocumentPropertiesUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Word.DocumentProperties): void;参数
- properties
- Word.DocumentProperties
返回
void
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.DocumentProperties 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.DocumentPropertiesData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.DocumentPropertiesData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.DocumentProperties;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.DocumentProperties;