Word.DocumentCompareOptions interface

Gibt die Optionen an, die in einem Dokumentvergleichsvorgang enthalten sein sollen.

Hinweise

API-Satz: WordApiDesktop 1.1

Verwendet von

Beispiele

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

Eigenschaften

addToRecentFiles

Gibt an, ob das Dokument der Liste der zuletzt verwendeten Dateien im Menü "Datei " hinzugefügt werden soll. Der Standardwert ist true.

authorName

Falls angegeben, gibt den Namen des Prüfers an, der den durch den Vergleich generierten Unterschieden zugeordnet ist. Wenn nicht angegeben, ist der Wert standardmäßig der Autorenname des überarbeiteten Dokuments oder die Zeichenfolge Comparison , wenn keine Autoreninformationen vorhanden sind.

compareTarget

Falls angegeben, wird das Zieldokument für den Vergleich angegeben. Der Standardwert ist compareTargetCurrent.

detectFormatChanges

Gibt (falls angegeben) an, ob der Vergleich die Erkennung von Formatänderungen beinhalten soll. Der Standardwert ist true.

ignoreAllComparisonWarnings

Gibt (falls angegeben) an, ob die Dokumente verglichen werden sollen, ohne einen Benutzer über Probleme zu informieren. Der Standardwert ist false.

removeDateAndTime

Gibt an, ob Datums- und Zeitstempelinformationen aus nachverfolgten Änderungen im zurückgegebenen Document Objekt entfernt werden sollen. Der Standardwert ist false.

removePersonalInformation

Gibt an, ob alle Benutzerinformationen aus Kommentaren, Revisionen und dem Dialogfeld "Eigenschaften" im zurückgegebenen Document Objekt entfernt werden sollen. Der Standardwert ist false.

Details zur Eigenschaft

addToRecentFiles

Gibt an, ob das Dokument der Liste der zuletzt verwendeten Dateien im Menü "Datei " hinzugefügt werden soll. Der Standardwert ist true.

addToRecentFiles?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.1

authorName

Falls angegeben, gibt den Namen des Prüfers an, der den durch den Vergleich generierten Unterschieden zugeordnet ist. Wenn nicht angegeben, ist der Wert standardmäßig der Autorenname des überarbeiteten Dokuments oder die Zeichenfolge Comparison , wenn keine Autoreninformationen vorhanden sind.

authorName?: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApiDesktop 1.1

compareTarget

Falls angegeben, wird das Zieldokument für den Vergleich angegeben. Der Standardwert ist compareTargetCurrent.

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

Eigenschaftswert

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

Hinweise

API-Satz: WordApiDesktop 1.1

detectFormatChanges

Gibt (falls angegeben) an, ob der Vergleich die Erkennung von Formatänderungen beinhalten soll. Der Standardwert ist true.

detectFormatChanges?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.1

ignoreAllComparisonWarnings

Gibt (falls angegeben) an, ob die Dokumente verglichen werden sollen, ohne einen Benutzer über Probleme zu informieren. Der Standardwert ist false.

ignoreAllComparisonWarnings?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.1

removeDateAndTime

Gibt an, ob Datums- und Zeitstempelinformationen aus nachverfolgten Änderungen im zurückgegebenen Document Objekt entfernt werden sollen. Der Standardwert ist false.

removeDateAndTime?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.1

removePersonalInformation

Gibt an, ob alle Benutzerinformationen aus Kommentaren, Revisionen und dem Dialogfeld "Eigenschaften" im zurückgegebenen Document Objekt entfernt werden sollen. Der Standardwert ist false.

removePersonalInformation?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.1