Word.Document class

参考

包:: word

Document 对象是顶层对象。 Document 对象包含一个或多个节、内容控件以及包含文档内容的正文。

Extends: OfficeExtension.ClientObject

注解

属性

body	获取main文档的正文对象。正文是排除页眉、页脚、脚注、文本框等的文本。
contentControls	获取文档中的内容控件对象的集合。这包括文档正文中的内容控件、页眉、页脚、文本框等。
context	与对象关联的请求上下文。这会将加载项的进程连接到 Office 主机应用程序的进程。
saved	指示是否已保存在文档中所做的更改。如果值为 true，表示文档自上次保存以来并未更改。
sections	获取文档中节对象的集合。

方法

getSelection()	获取文档的当前选定内容。不支持多个选择。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
save(saveBehavior, fileName)	保存文档。
save(saveBehaviorString, fileName)	保存文档。
set(properties, options)	同时设置对象的多个属性。可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 `JSON.stringify` (，反过来又调用`toJSON`传递给它的对象的方法。) 而原始Word。Document 对象是一个 API 对象，`toJSON`该方法返回一个纯 JavaScript 对象， (类型为 `Word.Interfaces.DocumentData`) ，其中包含原始对象中加载的任何子属性的浅表副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果跨 `.sync` 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。如果此对象是集合的一部分，则还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。在内存发布生效之前，需要调用 `context.sync()` 。

属性详细信息

body

获取main文档的正文对象。正文是排除页眉、页脚、脚注、文本框等的文本。

readonly body: Word.Body;

属性值

Word.Body

注解

[ API 集：WordApi 1.1 ]

contentControls

获取文档中的内容控件对象的集合。这包括文档正文中的内容控件、页眉、页脚、文本框等。

readonly contentControls: Word.ContentControlCollection;

属性值

Word.ContentControlCollection

注解

[ API 集：WordApi 1.1 ]

context

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

context: RequestContext;

属性值

Word.RequestContext

saved

指示是否已保存在文档中所做的更改。如果值为 true，表示文档自上次保存以来并未更改。

readonly saved: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.1 ]

sections

获取文档中节对象的集合。

readonly sections: Word.SectionCollection;

属性值

Word.SectionCollection

注解

[ API 集：WordApi 1.1 ]

方法详细信息

getSelection()

获取文档的当前选定内容。不支持多个选择。

getSelection(): Word.Range;

Word.Range

注解

[ API 集：WordApi 1.1 ]

示例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    const textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    const range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted the text at the end of the selection.');
});

load(options)

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

load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;

参数

options: Word.Interfaces.DocumentLoadOptions

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

Word.Document

示例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;
    
    // Queue a command to load content control properties.
    thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (thisDocument.contentControls.items.length !== 0) {
        for (let i = 0; i < thisDocument.contentControls.items.length; i++) {
            console.log(thisDocument.contentControls.items[i].id);
            console.log(thisDocument.contentControls.items[i].text);
            console.log(thisDocument.contentControls.items[i].tag);
        }
    } else {
        console.log('No content controls in this document.');
    }
});

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

Word.Document

load(propertyNamesAndPaths)

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

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

参数

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

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

Word.Document

save(saveBehavior, fileName)

保存文档。

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

参数

saveBehavior: Word.SaveBehavior

可选。保存行为必须为“保存”或“提示”。默认值为“Save”。

fileName: string

可选。文件名 (排除文件扩展名) 。仅对新文档生效。

void

注解

[ API 集：WordApi 1.1 ]

注意： saveBehavior 和 fileName 参数是在 WordApi 1.5 中引入的。

示例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;

    // Queue a command to load the document save state (on the saved property).
    thisDocument.load('saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (thisDocument.saved === false) {
        // Queue a command to save this document.
        thisDocument.save();
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Saved the document');
    } else {
        console.log('The document has not changed since the last save.');
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.save();
  await context.sync();
});

save(saveBehaviorString, fileName)

保存文档。

save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;

参数

saveBehaviorString: "Save" | "Prompt"

可选。保存行为必须为“保存”或“提示”。默认值为“Save”。

fileName: string

可选。文件名 (排除文件扩展名) 。仅对新文档生效。

void

注解

[ API 集：WordApi 1.1 ]

注意： saveBehavior 和 fileName 参数是在 WordApi 1.5 中引入的。

set(properties, options)

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

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

参数

properties: Word.Interfaces.DocumentUpdateData

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

options: OfficeExtension.UpdateOptions

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

void

set(properties)

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

set(properties: Word.Document): void;

参数

properties: Word.Document

void

toJSON()

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

toJSON(): Word.Interfaces.DocumentData;

Word.Interfaces.DocumentData

track()

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

track(): Word.Document;

Word.Document

untrack()

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

untrack(): Word.Document;

Word.Document

Share via

Word.Document class

注解

属性

方法

属性详细信息

body

属性值

注解

contentControls

属性值

注解

context

属性值

saved

属性值

注解

sections

属性值

注解

方法详细信息

getSelection()

返回

注解

示例

load(options)

参数

返回

示例

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

save(saveBehavior, fileName)

参数

返回

注解

示例

save(saveBehaviorString, fileName)

参数

返回

注解

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

反馈

其他资源