Word.DocumentCompareOptions interface

  • リファレンス
パッケージ:
word

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

比較ドキュメント操作に含めるオプションを指定します。

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/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 = {
    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.");
});

プロパティ

addToRecentFiles

True は、[ ファイル] メニューの最近使用したファイルの一覧にドキュメントを追加します。 既定値は True です。
authorName

比較によって変更を加える校閲者の名前を指定します。 この引数を省略すると、変更する文書の作成者の名前が既定値として設定されるか、または作成者の情報がない場合は "比較" という文字列が既定値として設定されます。
compareTarget

比較対象の文書です。 既定値は "CompareTargetCurrent" です。
detectFormatChanges

場合は true。 (既定値) の形式の変更の検出を含むように比較します。

ignoreAllComparisonWarnings

問題をユーザーに通知することがなく文書を比較する 場合は true です。 既定値は False です。
removeDateAndTime

True は、取得した Document オブジェクト内の変更履歴から日付と時刻のタイムスタンプ情報を削除します。 既定値は False です。
removePersonalInformation

True を指定すると、返された Document オブジェクトのコメント、リビジョン、およびプロパティ ダイアログ ボックスからすべてのユーザー情報が削除されます。 既定値は False です。

プロパティの詳細

addToRecentFiles

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

True は、[ ファイル] メニューの最近使用したファイルの一覧にドキュメントを追加します。 既定値は True です。

addToRecentFiles?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

authorName

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

比較によって変更を加える校閲者の名前を指定します。 この引数を省略すると、変更する文書の作成者の名前が既定値として設定されるか、または作成者の情報がない場合は "比較" という文字列が既定値として設定されます。

authorName?: string;

プロパティ値

string

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

compareTarget

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

比較対象の文書です。 既定値は "CompareTargetCurrent" です。

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

プロパティ値

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

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

detectFormatChanges

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

場合は true。 (既定値) の形式の変更の検出を含むように比較します。 

detectFormatChanges?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

ignoreAllComparisonWarnings

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

問題をユーザーに通知することがなく文書を比較する 場合は true です。 既定値は False です。

ignoreAllComparisonWarnings?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

removeDateAndTime

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

True は、取得した Document オブジェクト内の変更履歴から日付と時刻のタイムスタンプ情報を削除します。 既定値は False です。

removeDateAndTime?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

removePersonalInformation

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

True を指定すると、返された Document オブジェクトのコメント、リビジョン、およびプロパティ ダイアログ ボックスからすべてのユーザー情報が削除されます。 既定値は False です。

removePersonalInformation?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]