Word.Application class

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

context: RequestContext;

属性值

使用可选的 Base64 编码 .docx 文件创建新文档。

createDocument(base64File?: string): Word.DocumentCreated;

参数

返回

注解

[ API 集：WordApi 1.3 ]

示例

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

// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  const externalDoc: Word.DocumentCreated = context.application.createDocument(externalDocument);
  await context.sync();

  if (!Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.3")) {
    console.warn("The WordApiHiddenDocument 1.3 requirement set isn't supported on this client so can't proceed. Try this action on a platform that supports this requirement set.");
    return;
  }

  const externalDocBody: Word.Body = externalDoc.body;
  externalDocBody.load("text");
  await context.sync();

  // Insert the external document's text at the beginning of the current document's body.
  const externalDocBodyText = externalDocBody.text;
  const currentDocBody: Word.Body = context.document.body;
  currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
  await context.sync();
});

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

load(options?: Word.Interfaces.ApplicationLoadOptions): Word.Application;

参数

返回

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

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

参数

返回

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

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

参数

返回

创建 对象的新实例 Word.Application 。

static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;

参数

返回

打开文档并将其显示在新的选项卡或窗口中。 下面是各种受支持的客户端和平台的示例。

• 远程或云位置示例： https://microsoft.sharepoint.com/some/path/Document.docx

• Windows 的本地位置示例： C:\\Users\\Someone\\Documents\\Document.docx (包括必需的转义反斜杠) ， file://mycomputer/myfolder/Document.docx

• Mac 和 iOS 的本地位置示例： /User/someone/document.docx

openDocument(filePath: string): void;

参数

返回

注解

[ API 集：WordApi 1.6 ]

分析模板 Base64 文件中的样式，并将检索到的样式的 JSON 格式作为字符串返回。

retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;

参数

返回

注解

[ API 集：WordApi 1.5 ]

示例

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

// Gets style info from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  const retrievedStyles = context.application.retrieveStylesFromBase64(externalDocument);
  await context.sync();

  console.log("Styles from the other document:", retrievedStyles.value);
});

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

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

参数

返回

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

set(properties: Word.Application): void;

参数

返回

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

toJSON(): Word.Interfaces.ApplicationData;

返回