Word.WindowCloseOptions interface

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

注解

API 集:WordApiDesktop 1.4

使用方

示例

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

// Closes the active document window with Word's prompt-to-save option.
if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.4")) {
    console.error("This sample requires WordApiDesktop 1.4 or later.");
    return;
}

await Word.run(async (context) => {
    const window: Word.Window = context.document.activeWindow;
    const saveChanges: Word.SaveConfiguration = Word.SaveConfiguration.promptToSaveChanges;
    const closeOptions: Word.WindowCloseOptions = { saveChanges };
    console.log("About to close the document window...");
    window.close(closeOptions);
    await context.sync();
});

属性

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"

注解

API 集:WordApiDesktop 1.4