Compartilhar via


Word.DocumentCompareOptions interface

Especifica as opções a incluir numa operação de comparação de documentos.

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/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 = (document.getElementById("filePath") as HTMLInputElement).value;
  // Options that configure the compare operation.
  const options: Word.DocumentCompareOptions = {
    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

Se for fornecido, especifica se pretende adicionar o documento à lista de ficheiros utilizados recentemente no menu Ficheiro . O valor predefinido é true.

authorName

Se for fornecido, especifica o nome do revisor associado às diferenças geradas pela comparação. Se não for especificado, o valor é predefinido para o nome do autor do documento revisto ou da cadeia Comparison se não existirem informações de autor.

compareTarget

Se for fornecido, especifica o documento de destino para a comparação. O valor predefinido é compareTargetCurrent.

detectFormatChanges

Se for fornecido, especifica se a comparação deve incluir a deteção de alterações de formato. O valor predefinido é true.

ignoreAllComparisonWarnings

Se for fornecido, especifica se pretende comparar os documentos sem notificar um utilizador de problemas. O valor predefinido é false.

removeDateAndTime

Se for fornecido, especifica se pretende remover as informações do carimbo de data e hora das alterações registadas no objeto devolvido Document . O valor predefinido é false.

removePersonalInformation

Se for fornecido, especifica se pretende remover todas as informações do utilizador de comentários, revisões e a caixa de diálogo de propriedades no objeto devolvido Document . O valor predefinido é false.

Detalhes da propriedade

addToRecentFiles

Se for fornecido, especifica se pretende adicionar o documento à lista de ficheiros utilizados recentemente no menu Ficheiro . O valor predefinido é true.

addToRecentFiles?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

authorName

Se for fornecido, especifica o nome do revisor associado às diferenças geradas pela comparação. Se não for especificado, o valor é predefinido para o nome do autor do documento revisto ou da cadeia Comparison se não existirem informações de autor.

authorName?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

compareTarget

Se for fornecido, especifica o documento de destino para a comparação. O valor predefinido é compareTargetCurrent.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

detectFormatChanges

Se for fornecido, especifica se a comparação deve incluir a deteção de alterações de formato. O valor predefinido é true.

detectFormatChanges?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

ignoreAllComparisonWarnings

Se for fornecido, especifica se pretende comparar os documentos sem notificar um utilizador de problemas. O valor predefinido é false.

ignoreAllComparisonWarnings?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

removeDateAndTime

Se for fornecido, especifica se pretende remover as informações do carimbo de data e hora das alterações registadas no objeto devolvido Document . O valor predefinido é false.

removeDateAndTime?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

removePersonalInformation

Se for fornecido, especifica se pretende remover todas as informações do utilizador de comentários, revisões e a caixa de diálogo de propriedades no objeto devolvido Document . O valor predefinido é false.

removePersonalInformation?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]