Word.WindowCloseOptions interface

包:: word

用于定义是否在关闭前保存更改以及是否路由文档的选项。

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/close-document-window.yaml

await Word.run(async (context) => {
  // Closes the document window, prompting to save if this is a new document.
  const window: Word.Window = context.document.activeWindow;
  const closeOptions: Word.WindowCloseOptions = { saveChanges: Word.SaveConfiguration.promptToSaveChanges };
  console.log("About to close the document window...");
  window.close(closeOptions);
});

属性

routeDocument	如果提供，则指定是否将文档路由到下一个收件人。如果文档未附加路由单，则忽略此属性。
saveChanges	如果提供，则指定文档的保存作。有关可用值，请参阅 Word。SaveConfiguration。

属性详细信息

routeDocument

如果提供，则指定是否将文档路由到下一个收件人。如果文档未附加路由单，则忽略此属性。

routeDocument?: boolean;

属性值

boolean

注解

[ API 集：WordApiDesktop 1.4 ]

saveChanges

如果提供，则指定文档的保存作。有关可用值，请参阅 Word。SaveConfiguration。

saveChanges?: Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges";

属性值

Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges"

注解