Word.TrackedChange class

Stellt eine nachverfolgte Änderung in einem Word Dokument dar.

Extends

Hinweise

[ API-Satz: WordApi 1.6 ]

Eigenschaften

author

Ruft den Autor der nachverfolgten Änderung ab.

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

date

Ruft das Datum der nachverfolgten Änderung ab.

text

Ruft den Text der nachverfolgten Änderung ab.

type

Ruft den Typ der nachverfolgten Änderung ab.

Methoden

accept()

Akzeptiert die nachverfolgte Änderung.

getNext()

Ruft die nächste nachverfolgte Änderung ab. Löst einen Fehler aus ItemNotFound , wenn diese nachverfolgte Änderung die letzte ist.

getNextOrNullObject()

Ruft die nächste nachverfolgte Änderung ab. Wenn diese nachverfolgte Änderung die letzte ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getRange(rangeLocation)

Ruft den Bereich der nachverfolgten Änderung ab.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

reject()

Lehnt die nachverfolgte Änderung ab.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Die ursprüngliche Word. Das TrackedChange-Objekt ist ein API-Objekt. Die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TrackedChangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

author

Ruft den Autor der nachverfolgten Änderung ab.

readonly author: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.6 ]

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

date

Ruft das Datum der nachverfolgten Änderung ab.

readonly date: Date;

Eigenschaftswert

Date

Hinweise

[ API-Satz: WordApi 1.6 ]

text

Ruft den Text der nachverfolgten Änderung ab.

readonly text: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.6 ]

type

Ruft den Typ der nachverfolgten Änderung ab.

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

Eigenschaftswert

Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"

Hinweise

[ API-Satz: WordApi 1.6 ]

Details zur Methode

accept()

Akzeptiert die nachverfolgte Änderung.

accept(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.6 ]

Beispiele

// 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 = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  const trackedChange = trackedChanges.getFirst();
  trackedChange.load();
  await context.sync();

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

getNext()

Ruft die nächste nachverfolgte Änderung ab. Löst einen Fehler aus ItemNotFound , wenn diese nachverfolgte Änderung die letzte ist.

getNext(): Word.TrackedChange;

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.6 ]

Beispiele

// 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 = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  await context.sync();

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

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

  nextTrackedChange.load();
  await context.sync();

  console.log(nextTrackedChange);
});

getNextOrNullObject()

Ruft die nächste nachverfolgte Änderung ab. Wenn diese nachverfolgte Änderung die letzte ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextOrNullObject(): Word.TrackedChange;

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.6 ]

getRange(rangeLocation)

Ruft den Bereich der nachverfolgten Änderung ab.

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

Parameter

rangeLocation

whole | start | end | "Whole" | "Start" | "End"

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.6 ]

Beispiele

// 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 = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  const trackedChange = trackedChanges.getFirst();
  await context.sync();

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

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

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

options
Word.Interfaces.TrackedChangeLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

reject()

Lehnt die nachverfolgte Änderung ab.

reject(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.6 ]

Beispiele

// 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 = context.document.body;
  const trackedChanges = body.getTrackedChanges();
  const trackedChange = trackedChanges.getFirst();
  trackedChange.load();
  await context.sync();

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

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Die ursprüngliche Word. Das TrackedChange-Objekt ist ein API-Objekt. Die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TrackedChangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.TrackedChangeData;

Gibt zurück

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.TrackedChange;

Gibt zurück

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.TrackedChange;

Gibt zurück