Word.DocumentCompareOptions interface

  • Référence
Paquet:
word

Spécifie les options à inclure dans une opération de comparaison de document.

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

Exemples

// 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.");
});

Propriétés

addToRecentFiles

True ajoute le document à la liste des derniers fichiers utilisés dans le menu fichier. La valeur par défaut est True.
authorName

Nom du réviseur associé aux différences générées par la comparaison. Si vous ne spécifiez pas cet argument, il prend, par défaut, le nom de l'auteur du document révisé ou, si cette information n'est pas disponible, la chaîne « Comparaison ».
compareTarget

Le document cible pour la comparaison. La valeur par défaut est « CompareTargetCurrent ».
detectFormatChanges

True : (par défaut) pour que la comparaison détecte les modifications de format.
ignoreAllComparisonWarnings

True pour comparer les documents sans notifier de problèmes à un utilisateur. La valeur par défaut est False.
removeDateAndTime

True supprime les informations de date et date et heure du suivi des modifications dans l'objet Document renvoyé. La valeur par défaut est False.
removePersonalInformation

True supprime toutes les informations utilisateur des commentaires, des révisions et de la boîte de dialogue propriétés dans l’objet Document retourné. La valeur par défaut est False.

Détails de la propriété

addToRecentFiles

True ajoute le document à la liste des derniers fichiers utilisés dans le menu fichier. La valeur par défaut est True.

addToRecentFiles?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

authorName

Nom du réviseur associé aux différences générées par la comparaison. Si vous ne spécifiez pas cet argument, il prend, par défaut, le nom de l'auteur du document révisé ou, si cette information n'est pas disponible, la chaîne « Comparaison ».

authorName?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

compareTarget

Le document cible pour la comparaison. La valeur par défaut est « CompareTargetCurrent ».

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

detectFormatChanges

True : (par défaut) pour que la comparaison détecte les modifications de format.

detectFormatChanges?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

ignoreAllComparisonWarnings

True pour comparer les documents sans notifier de problèmes à un utilisateur. La valeur par défaut est False.

ignoreAllComparisonWarnings?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

removeDateAndTime

True supprime les informations de date et date et heure du suivi des modifications dans l'objet Document renvoyé. La valeur par défaut est False.

removeDateAndTime?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

removePersonalInformation

True supprime toutes les informations utilisateur des commentaires, des révisions et de la boîte de dialogue propriétés dans l’objet Document retourné. La valeur par défaut est False.

removePersonalInformation?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]