Word.DocumentCompareOptions interface
Gibt die Optionen an, die in einen Vergleichsdokumentvorgang einbezogen werden sollen.
Hinweise
[ API-Satz: WordApiDesktop 1.1 ]
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 = $("#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.");
});
Eigenschaften
| add |
Mit True wird das Dokument zur Liste der zuletzt verwendeten Dateien im Menü Datei hinzugefügt. Der Standardwert lautet "True". |
| author |
Der Name des Bearbeiters, der den im Vergleich festgestellten Unterschieden zugeordnet ist. Wenn dieser Name nicht angegeben wird und keine Informationen über den Autor vorhanden sind, wird standardmäßig der Name des Autors des überarbeiteten Dokuments oder die Zeichenfolge "Comparison" angezeigt. |
| compare |
Das Zieldokument für den Vergleich. Der Standardwert ist "CompareTargetCurrent". |
| detect |
True (Standardwert), wenn beim Vergleich auch Formatänderungen erkannt werden. |
| ignore |
Mit True werden die Dokumente verglichen, ohne dass der Benutzer über Probleme benachrichtigt wird. Der Standardwert ist False. |
| remove |
Mit True werden Datum und Zeitstempelangaben aus Überarbeitungen im zurückgegebenen Document-Objekt entfernt. Der Standardwert ist False. |
| remove |
True entfernt alle Benutzerinformationen aus Kommentaren, Überarbeitungen und dem Eigenschaftendialogfeld im zurückgegebenen Document-Objekt. Der Standardwert ist False. |
Details zur Eigenschaft
addToRecentFiles
Mit True wird das Dokument zur Liste der zuletzt verwendeten Dateien im Menü Datei hinzugefügt. Der Standardwert lautet "True".
addToRecentFiles?: boolean;Eigenschaftswert
boolean
Hinweise
authorName
Der Name des Bearbeiters, der den im Vergleich festgestellten Unterschieden zugeordnet ist. Wenn dieser Name nicht angegeben wird und keine Informationen über den Autor vorhanden sind, wird standardmäßig der Name des Autors des überarbeiteten Dokuments oder die Zeichenfolge "Comparison" angezeigt.
authorName?: string;Eigenschaftswert
string
Hinweise
compareTarget
Das Zieldokument für den Vergleich. Der Standardwert ist "CompareTargetCurrent".
compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";Eigenschaftswert
Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"
Hinweise
detectFormatChanges
True (Standardwert), wenn beim Vergleich auch Formatänderungen erkannt werden.
detectFormatChanges?: boolean;Eigenschaftswert
boolean
Hinweise
ignoreAllComparisonWarnings
Mit True werden die Dokumente verglichen, ohne dass der Benutzer über Probleme benachrichtigt wird. Der Standardwert ist False.
ignoreAllComparisonWarnings?: boolean;Eigenschaftswert
boolean
Hinweise
removeDateAndTime
Mit True werden Datum und Zeitstempelangaben aus Überarbeitungen im zurückgegebenen Document-Objekt entfernt. Der Standardwert ist False.
removeDateAndTime?: boolean;Eigenschaftswert
boolean
Hinweise
removePersonalInformation
True entfernt alle Benutzerinformationen aus Kommentaren, Überarbeitungen und dem Eigenschaftendialogfeld im zurückgegebenen Document-Objekt. Der Standardwert ist False.
removePersonalInformation?: boolean;Eigenschaftswert
boolean
Hinweise
Office Add-ins