Partager via

Word.DocumentCompareOptions interface

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

Propriétés

addToRecentFiles

S’il est fourni, spécifie s’il faut ajouter le document à la liste des fichiers récemment utilisés dans le menu Fichier . La valeur par défaut est true.
authorName

S’il est fourni, spécifie le nom du réviseur associé aux différences générées par la comparaison. Si elle n’est pas spécifiée, la valeur par défaut est le nom d’auteur du document révisé ou la chaîne Comparison si aucune information d’auteur n’est présente.
compareTarget

S’il est fourni, spécifie le document cible pour la comparaison. La valeur par défaut est compareTargetCurrent.
detectFormatChanges

Si elle est fournie, spécifie si la comparaison doit inclure la détection des modifications de format. La valeur par défaut est true.
ignoreAllComparisonWarnings

S’il est fourni, spécifie s’il faut comparer les documents sans avertir un utilisateur de problèmes. La valeur par défaut est false.
removeDateAndTime

S’il est fourni, spécifie s’il faut supprimer les informations de date et d’heure des modifications suivies dans l’objet retourné Document . La valeur par défaut est false.
removePersonalInformation

S’il est fourni, spécifie s’il faut supprimer toutes les informations utilisateur des commentaires, des révisions et de la boîte de dialogue des propriétés dans l’objet retourné Document . La valeur par défaut est false.

Détails de la propriété

addToRecentFiles

S’il est fourni, spécifie s’il faut ajouter le document à la liste des fichiers récemment 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

S’il est fourni, spécifie le nom du réviseur associé aux différences générées par la comparaison. Si elle n’est pas spécifiée, la valeur par défaut est le nom d’auteur du document révisé ou la chaîne Comparison si aucune information d’auteur n’est présente.

authorName?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

compareTarget

S’il est fourni, spécifie 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

Si elle est fournie, spécifie si la comparaison doit inclure la détection des modifications de format. La valeur par défaut est true.

detectFormatChanges?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

ignoreAllComparisonWarnings

S’il est fourni, spécifie s’il faut comparer les documents sans avertir un utilisateur de problèmes. La valeur par défaut est false.

ignoreAllComparisonWarnings?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

removeDateAndTime

S’il est fourni, spécifie s’il faut supprimer les informations de date et d’heure des modifications suivies dans l’objet retourné Document . La valeur par défaut est false.

removeDateAndTime?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

removePersonalInformation

S’il est fourni, spécifie s’il faut supprimer toutes les informations utilisateur des commentaires, des révisions et de la boîte de dialogue des propriétés dans l’objet retourné Document . La valeur par défaut est false.

removePersonalInformation?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]