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 = $("#filePath")
.val()
.toString();
// 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
| add |
True adiciona o documento à lista de arquivos recentemente usados no menu arquivo. O valor padrão é True. |
| author |
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. |
| compare |
O documento de destino para a comparação. O valor predefinido é "CompareTargetCurrent". |
| detect |
True (padrão) para a comparação incluir a detecção de mudanças de formato. |
| ignore |
True compara os documentos sem notificar o usuário de problemas. O valor padrão é False. |
| remove |
True remove as informações de carimbo de data e hora de alterações controladas no documento objeto retornado. O valor padrão é False. |
| remove |
True remove todas as informações de utilizador de comentários, revisões e a caixa de diálogo propriedades no objeto Documento devolvido. O valor padrão é False. |
Detalhes da propriedade
addToRecentFiles
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
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.
authorName?: string;Valor da propriedade
string
Comentários
compareTarget
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
detectFormatChanges
True (padrão) para a comparação incluir a detecção de mudanças de formato.
detectFormatChanges?: boolean;Valor da propriedade
boolean
Comentários
ignoreAllComparisonWarnings
True compara os documentos sem notificar o usuário de problemas. O valor padrão é False.
ignoreAllComparisonWarnings?: boolean;Valor da propriedade
boolean
Comentários
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.
removeDateAndTime?: boolean;Valor da propriedade
boolean
Comentários
removePersonalInformation
True remove todas as informações de utilizador de comentários, revisões e a caixa de diálogo propriedades no objeto Documento devolvido. O valor padrão é False.
removePersonalInformation?: boolean;Valor da propriedade
boolean