Word.DocumentProperties class

参考

包:: word

表示文档属性。

Extends: OfficeExtension.ClientObject

注解

示例

// 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));
});

属性

applicationName	获取 document 的应用程序名称。
author	指定文档的作者。
category	指定文档的类别。
comments	指定文档的注释。
company	指定文档的公司。
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
creationDate	获取文档的创建日期。
customProperties	获取 document 的一组 customProperty。
format	指定文档的格式。
keywords	指定文档的关键字。
lastAuthor	获取文档的最后一个作者。
lastPrintDate	获取文档的上次打印日期。
lastSaveTime	获取 document 的上次保存日期。
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。
subject	指定文档的主题。
template	获取文档的模板。
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`传递给它的对象的方法。) 而原始Word。DocumentProperties 对象是一个 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型为 `Word.Interfaces.DocumentPropertiesData`) ，其中包含原始对象中加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 `.sync` 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 `context.sync()` 。

属性详细信息

applicationName

获取 document 的应用程序名称。

readonly applicationName: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

author

指定文档的作者。

author: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

comments

指定文档的注释。

comments: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

company

指定文档的公司。

company: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

context

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

context: RequestContext;

属性值

Word.RequestContext

creationDate

获取文档的创建日期。

readonly creationDate: Date;

属性值

Date

注解

[ API 集：WordApi 1.3 ]

customProperties

获取 document 的一组 customProperty。

readonly customProperties: Word.CustomPropertyCollection;

属性值

Word.CustomPropertyCollection

注解

[ API 集：WordApi 1.3 ]

format

指定文档的格式。

format: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

keywords

指定文档的关键字。

keywords: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

lastAuthor

获取文档的最后一个作者。

readonly lastAuthor: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

lastPrintDate

获取文档的上次打印日期。

readonly lastPrintDate: Date;

属性值

Date

注解

[ API 集：WordApi 1.3 ]

lastSaveTime

获取 document 的上次保存日期。

readonly lastSaveTime: Date;

属性值

Date

注解

[ API 集：WordApi 1.3 ]

manager

指定文档的管理器。

manager: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

revisionNumber

获取文档的修订号。

readonly revisionNumber: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

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

注解

[ API 集：WordApi 1.3 ]

subject

指定文档的主题。

subject: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

template

获取文档的模板。

readonly template: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

title

指定文档的标题。

title: string;

属性值

string

注解

[ API 集：WordApi 1.3 ]

方法详细信息

load(options)

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

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

参数

options: Word.Interfaces.DocumentPropertiesLoadOptions

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

Word.DocumentProperties

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

Word.DocumentProperties

load(propertyNamesAndPaths)

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

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

参数

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

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

Word.DocumentProperties

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;

Word.Interfaces.DocumentPropertiesData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.DocumentProperties;

Word.DocumentProperties

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.DocumentProperties;

Word.DocumentProperties

通过

Word.DocumentProperties class

注解

示例

属性

方法

属性详细信息

applicationName

属性值

注解

author

属性值

注解

category

属性值

注解

comments

属性值

注解

company

属性值

注解

context

属性值

creationDate

属性值

注解

customProperties

属性值

注解

format

属性值

注解

keywords

属性值

注解

lastAuthor

属性值

注解

lastPrintDate

属性值

注解

lastSaveTime

属性值

注解

manager

属性值

注解

revisionNumber

属性值

注解

security

属性值

注解

subject

属性值

注解

template

属性值

注解

title

属性值

注解

方法详细信息

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()