Word.WindowCloseOptions interface

Paquete:
word

Opciones que definen si se deben guardar los cambios antes de cerrar y si se enruta el documento.

Comentarios

Conjunto de API: WordApiDesktop 1.4

Usada por

Ejemplos

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

Propiedades

routeDocument

Si se proporciona, especifica si se debe enrutar el documento al siguiente destinatario. Si el documento no tiene una lista de distribución adjunta, se omite esta propiedad.
saveChanges

Si se proporciona, especifica la acción de guardar para el documento. Para ver los valores disponibles, consulte Word. SaveConfiguration.

Detalles de las propiedades

routeDocument

Si se proporciona, especifica si se debe enrutar el documento al siguiente destinatario. Si el documento no tiene una lista de distribución adjunta, se omite esta propiedad.

routeDocument?: boolean;

Valor de propiedad

boolean

Comentarios

Conjunto de API: WordApiDesktop 1.4

saveChanges

Si se proporciona, especifica la acción de guardar para el documento. Para ver los valores disponibles, consulte Word. SaveConfiguration.

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

Valor de propiedad

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

Comentarios

Conjunto de API: WordApiDesktop 1.4