Word.WindowCloseOptions interface

Paquet:
word

Options qui définissent s’il faut enregistrer les modifications avant la fermeture et s’il faut acheminer le document.

Remarques

Ensemble d’API : WordApiDesktop 1.4

Utilisateur

Exemples

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

Propriétés

routeDocument

S’il est fourni, spécifie s’il faut acheminer le document vers le destinataire suivant. Si aucun bordereau de routage n’est attaché au document, cette propriété est ignorée.
saveChanges

Si elle est fournie, spécifie l’action d’enregistrement pour le document. Pour connaître les valeurs disponibles, consultez Word. SaveConfiguration.

Détails de la propriété

routeDocument

S’il est fourni, spécifie s’il faut acheminer le document vers le destinataire suivant. Si aucun bordereau de routage n’est attaché au document, cette propriété est ignorée.

routeDocument?: boolean;

Valeur de propriété

boolean

Remarques

Ensemble d’API : WordApiDesktop 1.4

saveChanges

Si elle est fournie, spécifie l’action d’enregistrement pour le document. Pour connaître les valeurs disponibles, consultez Word. SaveConfiguration.

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

Valeur de propriété

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

Remarques

Ensemble d’API : WordApiDesktop 1.4