Word.DocumentCompareOptions interface

Pacote:

word

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.

Especifica as opções a serem incluídas em uma operação de comparação de documento.

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/compare-documents.yaml

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = $("#filePath")
    .val()
    .toString();
  // Options that configure the compare operation.
  const options = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

Propriedades

addToRecentFiles	True adiciona o documento à lista de arquivos recentemente usados no menu arquivo. O valor padrão é True.
authorName	O nome do revisor associado com as diferenças geradas pela comparação. Se não especificado, o valor terá por padrão o nome do autor do documento revisado ou a sequência de caracteres "Comparison" se não houver nenhuma informação sobre o autor.
compareTarget	O documento de destino para a comparação. O valor padrão é 'CompareTargetCurrent'.
detectFormatChanges	True (padrão) para a comparação incluir a detecção de mudanças de formato.
ignoreAllComparisonWarnings	True compara os documentos sem notificar o usuário de problemas. O valor padrão é False.
removeDateAndTime	True remove as informações de carimbo de data e hora de alterações controladas no documento objeto retornado. O valor padrão é False.
removePersonalInformation	True remove todas as informações do usuário de comentários, revisões e da caixa de diálogo propriedades no objeto Document retornado. O valor padrão é False.

Detalhes da propriedade

addToRecentFiles

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.

True adiciona o documento à lista de arquivos recentemente usados no menu arquivo. O valor padrão é True.

addToRecentFiles?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

authorName

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.

O nome do revisor associado com as diferenças geradas pela comparação. Se não especificado, o valor terá por padrão o nome do autor do documento revisado ou a sequência de caracteres "Comparison" se não houver nenhuma informação sobre o autor.

authorName?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

compareTarget

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.

O documento de destino para a comparação. O valor padrão é 'CompareTargetCurrent'.

compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";

Valor da propriedade

Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

detectFormatChanges

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.

True (padrão) para a comparação incluir a detecção de mudanças de formato.

detectFormatChanges?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

ignoreAllComparisonWarnings

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.

True compara os documentos sem notificar o usuário de problemas. O valor padrão é False.

ignoreAllComparisonWarnings?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

removeDateAndTime

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.

True remove as informações de carimbo de data e hora de alterações controladas no documento objeto retornado. O valor padrão é False.

removeDateAndTime?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

removePersonalInformation

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.

True remove todas as informações do usuário de comentários, revisões e da caixa de diálogo propriedades no objeto Document retornado. O valor padrão é False.

removePersonalInformation?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]