Compartilhar via

Word.WindowCloseOptions interface

Pacote:
word

As opções que definem se pretende guardar as alterações antes de fechar e se pretende encaminhar o documento.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Exemplos

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

Propriedades

routeDocument

Se for fornecido, especifica se pretende encaminhar o documento para o destinatário seguinte. Se o documento não tiver uma lista de encaminhamento anexada, esta propriedade é ignorada.
saveChanges

Se for fornecido, especifica a ação guardar para o documento. Para obter os valores disponíveis, veja Word. SaveConfiguration.

Detalhes da propriedade

routeDocument

Se for fornecido, especifica se pretende encaminhar o documento para o destinatário seguinte. Se o documento não tiver uma lista de encaminhamento anexada, esta propriedade é ignorada.

routeDocument?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

saveChanges

Se for fornecido, especifica a ação guardar para o documento. Para obter os valores disponíveis, veja Word. SaveConfiguration.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]