Office.Body interface

Devolve todo o corpo atual no formato especificado por coercionType.

getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante:

• Ao trabalhar com corpos formatados em HTML, é importante ter em atenção que o valor devolvido pelo Body.getAsync método não será necessariamente o mesmo valor que foi transmitido anteriormente no Body.setAsync método . O cliente pode modificar o valor transmitido para setAsync para torná-lo composto de forma eficiente com o respetivo motor de composição.

• No Outlook na Web e no novo Outlook no Windows, especificar Office.CoercionType.Text na getAsync chamada pode nem sempre fornecer formatação fiável. Em vez disso, especifique Office.CoercionType.Html especialmente se o corpo contém elementos formatados, como tabelas, listas e ligações.

• No Outlook na Web e no novo Outlook no Windows, os utilizadores podem organizar as suas mensagens como conversações ou mensagens individuais na organização Definições>Mensagem deEsquema> deCorreio> (consulte Alterar a forma como a lista de mensagens é apresentada no Outlook). Esta definição afeta a quantidade de corpo de uma mensagem que é apresentada ao utilizador (ou seja, todo o tópico de conversação de uma mensagem ou apenas a mensagem atual). No modo Compose mensagem, especialmente para respostas a um tópico de conversação com mais do que uma mensagem, se quiser que o corpo devolvido reflita a definição do utilizador, especifique o bodyMode: Office.MailboxEnums.BodyMode.HostConfig parâmetro na sua getAsync chamada. Se as mensagens forem agrupadas por conversação, só é devolvido o corpo da resposta atual. Por outro lado, se as mensagens forem apresentadas individualmente, todo o tópico de conversação é devolvido.

• No Outlook em dispositivos móveis, a bodyMode propriedade está disponível a partir da Versão 4.2538.0.

• No Outlook em dispositivos móveis, especificar bodyMode: Office.MailboxEnums.BodyMode.HostConfig devolve o corpo da resposta atual.

• No Outlook em dispositivos móveis, enquanto estiver no modo de resposta rápida (o campo de resposta na parte inferior da mensagem), apenas o corpo da resposta atual é devolvido. Isto aplica-se mesmo que bodyMode: Office.MailboxEnums.BodyMode.FullBody seja especificado na getAsync chamada.

• A bodyMode opção não é suportada numa mensagem carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Devolve todo o corpo atual no formato especificado por coercionType.

getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose ou Leitura

Importante:

• Ao trabalhar com corpos formatados em HTML, é importante ter em atenção que o valor devolvido pelo Body.getAsync método não será necessariamente o mesmo valor que foi transmitido anteriormente no Body.setAsync método . O cliente pode modificar o valor transmitido para setAsync para torná-lo composto de forma eficiente com o respetivo motor de composição.

• No Outlook na Web e no novo Outlook no Windows, especificar Office.CoercionType.Text na getAsync chamada pode nem sempre fornecer formatação fiável. Em vez disso, especifique Office.CoercionType.Html especialmente se o corpo contém elementos formatados, como tabelas, listas e ligações.

• No Outlook na Web e no novo Outlook no Windows, os utilizadores podem organizar as suas mensagens como conversações ou mensagens individuais na organização Definições>Mensagem deEsquema> deCorreio> (consulte Alterar a forma como a lista de mensagens é apresentada no Outlook). Esta definição afeta a quantidade de corpo de uma mensagem que é apresentada ao utilizador (ou seja, todo o tópico de conversação de uma mensagem ou apenas a mensagem atual). No modo Compose mensagem, especialmente para respostas a um tópico de conversação com mais do que uma mensagem, se quiser que o corpo devolvido reflita a definição do utilizador, especifique o bodyMode: Office.MailboxEnums.BodyMode.HostConfig parâmetro na sua getAsync chamada. Se as mensagens forem agrupadas por conversação, só é devolvido o corpo da resposta atual. Por outro lado, se as mensagens forem apresentadas individualmente, todo o tópico de conversação é devolvido.

• No Outlook em dispositivos móveis, a bodyMode propriedade está disponível a partir da Versão 4.2538.0.

• No Outlook em dispositivos móveis, especificar bodyMode: Office.MailboxEnums.BodyMode.HostConfig devolve o corpo da resposta atual.

• No Outlook em dispositivos móveis, enquanto estiver no modo de resposta rápida (o campo de resposta na parte inferior da mensagem), apenas o corpo da resposta atual é devolvido. Isto aplica-se mesmo que bodyMode: Office.MailboxEnums.BodyMode.FullBody seja especificado na getAsync chamada.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

// Get the current body of the message or appointment.
Office.context.mailbox.item.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to get body: ${bodyResult.error.message}`);
    return;
  }

  // Add the Base64-encoded image to the end of the body.
  const options = { isInline: true, asyncContext: bodyResult.value };
  Office.context.mailbox.item.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
    if (attachResult.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to attach file: ${attachResult.error.message}`);
      return;
    }

    let body = attachResult.asyncContext;
    body += '<img src="cid:sample.png" />';

    Office.context.mailbox.item.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
      if (setResult.status === Office.AsyncResultStatus.Failed) {
        console.log(`Failed to set body: ${setResult.error.message}`);
        return;
      }
      
      console.log("Inline Base64-encoded image added to the end of the body.");
    });
  });
});

Obtém um valor que indica se o conteúdo está em formato HTML ou texto.

getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose

Importante: no Outlook para Android e no iOS, este método não é suportado no modo Compose mensagens. Apenas o modo Organizador de Compromissos é suportado. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-body-format.yaml

// Get the mail item's body format (plain text or HTML) and log it to the console.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Body format: " + asyncResult.value);
});

Obtém um valor que indica se o conteúdo está em formato HTML ou texto.

getTypeAsync(callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compose

Importante: no Outlook para Android e no iOS, este método não é suportado no modo Compose mensagens. Apenas o modo Organizador de Compromissos é suportado. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

Adiciona o conteúdo especificado ao início do corpo do item.

prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

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

Modo Outlook aplicável: Compose

Recomendado: chame getTypeAsynce, em seguida, transmita o valor devolvido para o options.coercionType parâmetro .

Importante:

• Depois de o conteúdo ser pré-anexado, a posição do cursor depende do cliente em que o suplemento está em execução. No Outlook na Web e no Windows (novo e clássico), a posição do cursor permanece a mesma no conteúdo pré-existente do corpo. Por exemplo, se o cursor tiver sido posicionado no início do corpo antes prependAsync da chamada, será apresentado entre o conteúdo pré-anexado e o conteúdo pré-existente do corpo após a chamada. No Outlook para Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só volta a aparecer quando o utilizador seleciona algo no corpo do item de correio.

• Ao trabalhar com corpos formatados em HTML, é importante ter em atenção que o cliente pode modificar o valor transmitido para prependAsync o tornar eficiente com o motor de composição. Isto significa que o valor devolvido de uma chamada subsequente ao Body.getAsync método (introduzido na Caixa de Correio 1.3) não conterá necessariamente o valor exato que foi transmitido na chamada anterior prependAsync .

• Ao incluir ligações na marcação HTML, pode desativar a pré-visualização da ligação online ao definir o id atributo na âncora (<a>) como "LPNoLP" (consulte a secção Exemplos de um exemplo).

• No Outlook para Android e no iOS, este método não é suportado no modo de Compose mensagens. Apenas o modo Organizador de Compromissos é suportado. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

• Os ficheiros SVG não são suportados. Em alternativa, utilize ficheiros JPG ou PNG.

• O prependAsync método não suporta CSS inline. Em alternativa, utilize CSS interno ou externo.

• O prependAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

• DataExceedsMaximumSize : o parâmetro de dados tem mais de 1000 000 carateres.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/prepend-text-to-item-body.yaml

/* This snippet adds text to the beginning of the message or appointment's body. 

  When prepending a link in HTML markup to the body, you can disable the online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="https://www.contoso.com">Click here!</a>'.
*/
const text = (document.getElementById("text-field") as HTMLInputElement).value;

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" prepended to the body.`);
  });
});

Adiciona o conteúdo especificado ao início do corpo do item.

prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

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

Modo Outlook aplicável: Compose

Recomendado: chame getTypeAsynce, em seguida, transmita o valor devolvido para o options.coercionType parâmetro .

Importante:

• Depois de o conteúdo ser pré-anexado, a posição do cursor depende do cliente em que o suplemento está em execução. No Outlook na Web e no Windows (novo e clássico), a posição do cursor permanece a mesma no conteúdo pré-existente do corpo. Por exemplo, se o cursor tiver sido posicionado no início do corpo antes prependAsync da chamada, será apresentado entre o conteúdo pré-anexado e o conteúdo pré-existente do corpo após a chamada. No Outlook para Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só volta a aparecer quando o utilizador seleciona algo no corpo do item de correio.

• Ao trabalhar com corpos formatados em HTML, é importante ter em atenção que o cliente pode modificar o valor transmitido para prependAsync o tornar eficiente com o motor de composição. Isto significa que o valor devolvido de uma chamada subsequente ao Body.getAsync método (introduzido na Caixa de Correio 1.3) não conterá necessariamente o valor exato que foi transmitido na chamada anterior prependAsync .

• Ao incluir ligações na marcação HTML, pode desativar a pré-visualização da ligação online ao definir o id atributo na âncora (<a>) como "LPNoLP" (consulte a secção Exemplos de um exemplo).

• No Outlook para Android e no iOS, este método não é suportado no modo de Compose mensagens. Apenas o modo Organizador de Compromissos é suportado. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

• Os ficheiros SVG não são suportados. Em alternativa, utilize ficheiros JPG ou PNG.

• O prependAsync método não suporta CSS inline. Em alternativa, utilize CSS interno ou externo.

• O prependAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

• DataExceedsMaximumSize : o parâmetro de dados tem mais de 1000 000 carateres.

Substitui todo o corpo com o texto especificado.

setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

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

Modo Outlook aplicável: Compose

Recomendado: chame getTypeAsynce, em seguida, transmita o valor devolvido para o options.coercionType parâmetro .

Importante:

• Depois de o corpo ser substituído pelo conteúdo especificado, a posição do cursor depende do cliente em que o suplemento está em execução. No Outlook clássico no Windows, o cursor é apresentado no início do corpo do item de correio. No Outlook na Web e no novo Outlook no Windows, o cursor é apresentado no final do corpo do item de correio. No Outlook para Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só volta a aparecer quando o utilizador seleciona algo no corpo do item de correio.

• Ao trabalhar com corpos formatados em HTML, é importante ter em atenção que o valor devolvido pelo Body.getAsync método não será necessariamente o mesmo valor que foi transmitido anteriormente no Body.setAsync método . O cliente pode modificar o valor transmitido para setAsync para torná-lo composto de forma eficiente com o respetivo motor de composição.

• Ao incluir ligações na marcação HTML, pode desativar a pré-visualização da ligação online ao definir o id atributo na âncora (<a>) como "LPNoLP" (consulte a secção Exemplos de um exemplo).

• No Outlook no Windows (clássico) e no Mac, o utilizador do suplemento não consegue reverter esta ação com o comando Anular.

• No Outlook para Android e no iOS, este método não é suportado no modo de Compose mensagens. Apenas o modo Organizador de Compromissos é suportado. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

• Os ficheiros SVG não são suportados. Em alternativa, utilize ficheiros JPG ou PNG.

• O setAsync método não suporta CSS inline. Em alternativa, utilize CSS interno ou externo.

• O setAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

• No Outlook na Web e no novo Outlook no Windows, os utilizadores podem organizar as suas mensagens como conversações ou mensagens individuais na organização Definições>Mensagem deEsquema> deCorreio> (consulte Alterar a forma como a lista de mensagens é apresentada no Outlook). Esta definição afeta a quantidade de corpo de uma mensagem que é apresentada ao utilizador (ou seja, todo o tópico de conversação de uma mensagem ou apenas a mensagem atual). No modo Compose mensagem, especialmente para respostas a um tópico de conversação com mais do que uma mensagem, se quiser respeitar as definições do utilizador ao definir o corpo de uma mensagem, especifique o bodyMode: Office.MailboxEnums.BodyMode.HostConfig parâmetro na sua setAsync chamada. Se as mensagens estiverem agrupadas por conversação, apenas o corpo da resposta atual é definido. Por outro lado, se as mensagens forem apresentadas individualmente, todo o corpo, incluindo mensagens anteriores no tópico de conversação, será substituído.

• No Outlook na Web e no novo Outlook no Windows, se a bodyMode propriedade não for especificada ou estiver definida como Office.MailboxEnums.BodyMode.FullBody, todo o corpo de uma mensagem, incluindo mensagens anteriores do tópico de conversação, será substituído. Isto aplica-se mesmo que as mensagens de um utilizador estejam organizadas por conversação. Neste cenário, a definição do utilizador é alterada temporariamente para Mensagens individuais: Não agrupe mensagens>Apenas uma única mensagem ou Mostrar e-mail como mensagens individuais durante a setAsync chamada. É apresentada uma notificação ao utilizador para alertá-lo para esta alteração. Após a conclusão da chamada, a definição do utilizador é restabelecida.

Erros:

• DataExceedsMaximumSize : o parâmetro de dados tem mais de 1000 000 carateres.

• InvalidFormatError : o options.coercionType parâmetro está definido como Office.CoercionType.Html e o corpo da mensagem está em texto simples.

Exemplos

// When including links in HTML markup, you can disable online link preview
// by setting the id attribute on the anchor (<a>) to "LPNoLP".
Office.context.mailbox.item.body.setAsync(
    '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>',
    { 
        coercionType: Office.CoercionType.Html,
        asyncContext: "This is passed to the callback"
    },
    (result) => {
        // Process the result.
    }
);

// The following is an example of the result parameter passed to the callback function.
{
    "value": null,
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

// Get the current body of the message or appointment.
Office.context.mailbox.item.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to get body: ${bodyResult.error.message}`);
    return;
  }

  // Add the Base64-encoded image to the end of the body.
  const options = { isInline: true, asyncContext: bodyResult.value };
  Office.context.mailbox.item.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
    if (attachResult.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to attach file: ${attachResult.error.message}`);
      return;
    }

    let body = attachResult.asyncContext;
    body += '<img src="cid:sample.png" />';

    Office.context.mailbox.item.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
      if (setResult.status === Office.AsyncResultStatus.Failed) {
        console.log(`Failed to set body: ${setResult.error.message}`);
        return;
      }
      
      console.log("Inline Base64-encoded image added to the end of the body.");
    });
  });
});

Substitui todo o corpo com o texto especificado.

setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.3 ]

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

Modo Outlook aplicável: Compose

Recomendado: chame getTypeAsynce, em seguida, transmita o valor devolvido para o options.coercionType parâmetro .

Importante:

• Depois de o corpo ser substituído pelo conteúdo especificado, a posição do cursor depende do cliente em que o suplemento está em execução. No Outlook clássico no Windows, o cursor é apresentado no início do corpo do item de correio. No Outlook na Web e no novo Outlook no Windows, o cursor é apresentado no final do corpo do item de correio. No Outlook para Mac, a posição do cursor não é preservada. O cursor desaparece após a prependAsync chamada e só volta a aparecer quando o utilizador seleciona algo no corpo do item de correio.

• Ao trabalhar com corpos formatados em HTML, é importante ter em atenção que o valor devolvido pelo Body.getAsync método não será necessariamente o mesmo valor que foi transmitido anteriormente no Body.setAsync método . O cliente pode modificar o valor transmitido para setAsync para torná-lo composto de forma eficiente com o respetivo motor de composição.

• Ao incluir ligações na marcação HTML, pode desativar a pré-visualização da ligação online ao definir o id atributo na âncora (<a>) como "LPNoLP" (consulte a secção Exemplos de um exemplo).

• No Outlook no Windows (clássico) e no Mac, o utilizador do suplemento não consegue reverter esta ação com o comando Anular.

• No Outlook para Android e no iOS, este método não é suportado no modo de Compose mensagens. Apenas o modo Organizador de Compromissos é suportado. Para obter mais informações sobre as APIs suportadas no Outlook Mobile, consulte ApIs JavaScript do Outlook suportadas no Outlook em dispositivos móveis.

• Os ficheiros SVG não são suportados. Em alternativa, utilize ficheiros JPG ou PNG.

• O setAsync método não suporta CSS inline. Em alternativa, utilize CSS interno ou externo.

• O setAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

• No Outlook na Web e no novo Outlook no Windows, os utilizadores podem organizar as suas mensagens como conversações ou mensagens individuais na organização Definições>Mensagem deEsquema> deCorreio> (consulte Alterar a forma como a lista de mensagens é apresentada no Outlook). Esta definição afeta a quantidade de corpo de uma mensagem que é apresentada ao utilizador (ou seja, todo o tópico de conversação de uma mensagem ou apenas a mensagem atual). No modo Compose mensagem, especialmente para respostas num tópico de conversação com mais do que uma mensagem, se quiser respeitar as definições do utilizador ao definir o corpo de uma mensagem, especifique o bodyMode: Office.MailboxEnums.BodyMode.HostConfig parâmetro na sua setAsync chamada. Se as mensagens estiverem agrupadas por conversação, apenas o corpo da resposta atual é definido. Por outro lado, se as mensagens forem apresentadas individualmente, todo o corpo, incluindo mensagens anteriores no tópico de conversação, será substituído.

• No Outlook na Web e no novo Outlook no Windows, se a bodyMode propriedade não for especificada ou estiver definida como Office.MailboxEnums.BodyMode.FullBody, todo o corpo de uma mensagem, incluindo mensagens anteriores do tópico de conversação, será substituído. Isto aplica-se mesmo que as mensagens de um utilizador estejam organizadas por conversação. Neste cenário, a definição do utilizador é alterada temporariamente para Mensagens individuais: Não agrupe mensagens>Apenas uma única mensagem ou Mostrar e-mail como mensagens individuais durante a setAsync chamada. É apresentada uma notificação ao utilizador para alertá-lo para esta alteração. Após a conclusão da chamada, a definição do utilizador é restabelecida.

Erros:

• DataExceedsMaximumSize : o parâmetro de dados tem mais de 1000 000 carateres.

• InvalidFormatError : o options.coercionType parâmetro está definido como Office.CoercionType.Html e o corpo da mensagem está em texto simples.

Substitui a seleção no corpo pelo texto especificado.

O método setSelectedDataAsync insere a cadeia de caracteres especificada no local do cursor no corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor nunca esteve no corpo do item, ou se o corpo do item perdeu o destaque na interface de usuário, a cadeia de caracteres será inserida na parte superior do conteúdo do corpo. Após a inserção, o cursor é colocado no final do conteúdo inserido.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

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

Modo Outlook aplicável: Compose

Recomendado: chame getTypeAsync e, em seguida, transmita o valor devolvido para o options.coercionType parâmetro .

* Importante:

• Ao incluir ligações na marcação HTML, pode desativar a pré-visualização da ligação online ao definir o id atributo na âncora (<a>) como "LPNoLP" (consulte a secção Exemplos de um exemplo).

• Os ficheiros SVG não são suportados. Em alternativa, utilize ficheiros JPG ou PNG.

• O setSelectedDataAsync método não suporta CSS inline. Em alternativa, utilize CSS interno ou externo.

• O setSelectedDataAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

• DataExceedsMaximumSize : o data parâmetro tem mais de 1000 000 carateres.

• InvalidFormatError : o options.coercionType parâmetro está definido como Office.CoercionType.Html e o corpo da mensagem está em texto simples.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/replace-selected-text.yaml

/* This snippet replaces selected text in a message or appointment's body with specified text.

  If you want to use a link in HTML markup as a value of the setSelectedDataAsync call's data parameter, you can disable online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="https://www.contoso.com">Click here!</a>'.
*/
const text = (document.getElementById("text-field") as HTMLInputElement).value;

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.setSelectedDataAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`Replaced selected text with "${text}".`);
  });
});

Substitui a seleção no corpo pelo texto especificado.

O método setSelectedDataAsync insere a cadeia de caracteres especificada no local do cursor no corpo do item ou, se o texto estiver selecionado no editor, substitui o texto selecionado. Se o cursor nunca esteve no corpo do item, ou se o corpo do item perdeu o destaque na interface de usuário, a cadeia de caracteres será inserida na parte superior do conteúdo do corpo. Após a inserção, o cursor é colocado no final do conteúdo inserido.

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

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

Modo Outlook aplicável: Compose

Recomendado: chame getTypeAsync e, em seguida, transmita o valor devolvido para o options.coercionType parâmetro .

* Importante:

• Ao incluir ligações na marcação HTML, pode desativar a pré-visualização da ligação online ao definir o id atributo na âncora (<a>) como "LPNoLP" (consulte a secção Exemplos de um exemplo).

• Os ficheiros SVG não são suportados. Em alternativa, utilize ficheiros JPG ou PNG.

• O setSelectedDataAsync método não suporta CSS inline. Em alternativa, utilize CSS interno ou externo.

• O setSelectedDataAsync método não é suportado numa mensagem atualmente carregada com o loadItemByIdAsync método . Para obter mais informações, consulte Ativar o seu suplemento do Outlook em várias mensagens.

Erros:

• DataExceedsMaximumSize : o data parâmetro tem mais de 1000 000 carateres.

• InvalidFormatError : o options.coercionType parâmetro está definido como Office.CoercionType.Html e o corpo da mensagem está em texto simples.