Freigeben über

Word.WindowCloseOptions interface

Paket:
word

Die Optionen, die definieren, ob Änderungen vor dem Schließen gespeichert werden sollen und ob das Dokument weitergeleitet werden soll.

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Beispiele

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

Eigenschaften

routeDocument

Gibt an, ob das Dokument an den nächsten Empfänger weitergeleitet werden soll, falls angegeben. Wenn dem Dokument kein Verteiler angefügt ist, wird diese Eigenschaft ignoriert.
saveChanges

Wenn angegeben, gibt die Speicheraktion für das Dokument an. Verfügbare Werte finden Sie unter Word. SaveConfiguration.

Details zur Eigenschaft

routeDocument

Gibt an, ob das Dokument an den nächsten Empfänger weitergeleitet werden soll, falls angegeben. Wenn dem Dokument kein Verteiler angefügt ist, wird diese Eigenschaft ignoriert.

routeDocument?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

saveChanges

Wenn angegeben, gibt die Speicheraktion für das Dokument an. Verfügbare Werte finden Sie unter Word. SaveConfiguration.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]