Compartilhar via


Office.Display interface

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Fornece propriedades para definir temporariamente o conteúdo exibido no corpo ou assunto de uma mensagem no modo de leitura.

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: Leitura de mensagem

Propriedades

body

Obtém um objeto para definir temporariamente o conteúdo exibido no corpo de uma mensagem no modo de leitura.

subject

Obtém um objeto para definir temporariamente o conteúdo exibido no assunto de uma mensagem no modo de leitura.

Detalhes da propriedade

body

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém um objeto para definir temporariamente o conteúdo exibido no corpo de uma mensagem no modo de leitura.

body: DisplayedBody;

Valor da propriedade

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: Leitura de mensagem

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the body of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const bodyText = $("#body-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.body.setAsync(bodyText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the body.");
});

subject

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém um objeto para definir temporariamente o conteúdo exibido no assunto de uma mensagem no modo de leitura.

subject: DisplayedSubject;

Valor da propriedade

Comentários

[ Conjunto de API: visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: Leitura de mensagem

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the subject field of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const subjectText = $("#subject-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.subject.setAsync(subjectText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the subject field.");
});