Word.DocumentCompareOptions interface
指定要包含在比较文档操作中的选项。
注解
示例
// 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.");
});
属性
| add |
True 将文档添加到 文件菜单上最近使用的文件列表。 默认值为 True。 |
| author |
与比较生成的区别相关联的审阅者姓名。 如果没有指定，则默认值为修订的文档的作者姓名或字符串"Comparison"（如果没有提供作者信息）。 |
| compare |
比较的目标文档。 默认值为“CompareTargetCurrent”。 |
| detect |
真 (默认值) 进行比较以包含检测到的格式更改。 |
| ignore |
真正 比较文档，而不必通知用户有问题存在。 默认值为 False。 |
| remove |
为 日期和时间戳信息从修订中移除返回的 文档 对象中。 默认值为 False。 |
| remove |
如果为 True，则从返回的 Document 对象中的注释、修订和属性对话框中删除所有用户信息。 默认值为 False。 |
属性详细信息
addToRecentFiles
True 将文档添加到 文件菜单上最近使用的文件列表。 默认值为 True。
addToRecentFiles?: boolean;属性值
boolean
注解
authorName
与比较生成的区别相关联的审阅者姓名。 如果没有指定，则默认值为修订的文档的作者姓名或字符串"Comparison"（如果没有提供作者信息）。
authorName?: string;属性值
string
注解
compareTarget
比较的目标文档。 默认值为“CompareTargetCurrent”。
compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";属性值
Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"
注解
detectFormatChanges
ignoreAllComparisonWarnings
真正 比较文档，而不必通知用户有问题存在。 默认值为 False。
ignoreAllComparisonWarnings?: boolean;属性值
boolean
注解
removeDateAndTime
为 日期和时间戳信息从修订中移除返回的 文档 对象中。 默认值为 False。
removeDateAndTime?: boolean;属性值
boolean
注解
removePersonalInformation
如果为 True，则从返回的 Document 对象中的注释、修订和属性对话框中删除所有用户信息。 默认值为 False。
removePersonalInformation?: boolean;属性值
boolean