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 = (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.");
});
プロパティ
| add |
指定した場合は、[ ファイル ] メニューの最近使用したファイルの一覧にドキュメントを追加するかどうかを指定します。 既定値は |
| author |
指定した場合は、比較によって生成された相違点に関連付けられたレビューアー名を指定します。 指定しない場合、値のデフォルトは、改訂された文書の作成者名、または作成者情報が存在しない場合は文字列 |
| compare |
指定する場合は、比較の対象ドキュメントを指定します。 既定値は |
| detect |
指定した場合は、比較にフォーマット変更の検出を含める必要があるかどうかを指定します。 既定値は |
| ignore |
指定された場合、ユーザーに問題を通知せずにドキュメントを比較するかどうかを指定します。 既定値は |
| remove |
指定した場合、返された |
| remove |
指定した場合、返される |
プロパティの詳細
addToRecentFiles
指定した場合は、[ ファイル ] メニューの最近使用したファイルの一覧にドキュメントを追加するかどうかを指定します。 既定値は true です。
addToRecentFiles?: boolean;プロパティ値
boolean
注釈
authorName
指定した場合は、比較によって生成された相違点に関連付けられたレビューアー名を指定します。 指定しない場合、値のデフォルトは、改訂された文書の作成者名、または作成者情報が存在しない場合は文字列 Comparison になります。
authorName?: string;プロパティ値
string
注釈
compareTarget
指定する場合は、比較の対象ドキュメントを指定します。 既定値は compareTargetCurrent です。
compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";プロパティ値
Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"
注釈
detectFormatChanges
指定した場合は、比較にフォーマット変更の検出を含める必要があるかどうかを指定します。 既定値は true です。
detectFormatChanges?: boolean;プロパティ値
boolean
注釈
ignoreAllComparisonWarnings
指定された場合、ユーザーに問題を通知せずにドキュメントを比較するかどうかを指定します。 既定値は false です。
ignoreAllComparisonWarnings?: boolean;プロパティ値
boolean
注釈
removeDateAndTime
指定した場合、返された Document オブジェクトの変更履歴から日付とタイムスタンプ情報を削除するかどうかを指定します。 既定値は false です。
removeDateAndTime?: boolean;プロパティ値
boolean
注釈
removePersonalInformation
指定した場合、返される Document オブジェクトのコメント、リビジョン、およびプロパティ ダイアログ ボックスからすべてのユーザー情報を削除するかどうかを指定します。 既定値は false です。
removePersonalInformation?: boolean;プロパティ値
boolean