Word.TrackedChange class

変更履歴の作成者を取得します。

readonly author: string;

プロパティ値

注釈

API セット: WordApi 1.6

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

変更履歴の日付を取得します。

readonly date: Date;

プロパティ値

注釈

API セット: WordApi 1.6

変更履歴のテキストを取得します。

readonly text: string;

プロパティ値

注釈

API セット: WordApi 1.6

変更履歴の種類を取得します。

readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";

プロパティ値

注釈

API セット: WordApi 1.6

変更履歴を受け入れます。

accept(): void;

返品

注釈

API セット: WordApi 1.6

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml

// Accepts the first tracked change.
await Word.run(async (context) => {
  const body: Word.Body = context.document.body;
  const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
  const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
  trackedChange.load();
  await context.sync();

  console.log("First tracked change:", trackedChange);
  trackedChange.accept();
  console.log("Accepted the first tracked change.");
});

次に追跡された変更を取得します。 この変更が追跡された最後のものである場合は、 ItemNotFound エラーをスローします。

getNext(): Word.TrackedChange;

返品

注釈

API セット: WordApi 1.6

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml

// Gets the next (second) tracked change.
await Word.run(async (context) => {
  const body: Word.Body = context.document.body;
  const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
  await context.sync();

  const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
  await context.sync();

  const nextTrackedChange: Word.TrackedChange = trackedChange.getNext();
  await context.sync();

  nextTrackedChange.load(["author", "date", "text", "type"]);
  await context.sync();

  console.log(nextTrackedChange);
});

次に追跡された変更を取得します。 この追跡された変更が最後のものである場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getNextOrNullObject(): Word.TrackedChange;

返品

注釈

API セット: WordApi 1.6

変更履歴の範囲を取得します。

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

パラメーター

返品

注釈

API セット: WordApi 1.6

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml

// Gets the range of the first tracked change.
await Word.run(async (context) => {
  const body: Word.Body = context.document.body;
  const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
  const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
  await context.sync();

  const range: Word.Range = trackedChange.getRange();
  range.load();
  await context.sync();

  console.log("range.text: " + range.text);
});

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Word.TrackedChange;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TrackedChange;

パラメーター

返品

変更履歴を元に戻します。

reject(): void;

返品

注釈

API セット: WordApi 1.6

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml

// Rejects the first tracked change.
await Word.run(async (context) => {
  const body: Word.Body = context.document.body;
  const trackedChanges: Word.TrackedChangeCollection = body.getTrackedChanges();
  const trackedChange: Word.TrackedChange = trackedChanges.getFirst();
  trackedChange.load();
  await context.sync();

  console.log("First tracked change:", trackedChange);
  trackedChange.reject();
  console.log("Rejected the first tracked change.");
});

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.TrackedChange オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TrackedChangeData と型指定) を返します。

toJSON(): Word.Interfaces.TrackedChangeData;

返品

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.TrackedChange;

返品

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.TrackedChange;

返品