Word.Revision class
Stellt eine einzelne nachverfolgte Änderung in einem Dokument dar.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml
// Reads revision metadata for the first paragraph on desktop Word.
await Word.run(async (context) => {
const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
const revisions: Word.RevisionCollection = paragraphRange.revisions;
revisions.load("items/author,items/date,items/type,items/index,items/formatDescription");
await context.sync();
console.log(`Revisions in the first paragraph: ${revisions.items.length}`);
revisions.items.forEach((revision: Word.Revision) => {
console.log("Revision properties:", {
author: revision.author,
date: revision.date,
type: revision.type,
index: revision.index,
formatDescription: revision.formatDescription,
});
});
});
Eigenschaften
| author | Ruft den Namen des Benutzers ab, der die nachverfolgte Änderung vorgenommen hat. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| date | Ruft das Datum und die Uhrzeit ab, zu der die nachverfolgte Änderung vorgenommen wurde. |
| format |
Ruft die Beschreibung der nachverfolgten Formatierungsänderungen in der Revision ab. |
| index | Ruft eine Zahl ab, die die Position dieses Elements in einer Sammlung darstellt. |
| moved |
Ruft ein |
| range | Ruft ein |
| type | Ruft den Revisionstyp ab. |
Methoden
| accept() | Akzeptiert die nachverfolgte Änderung, entfernt die Überarbeitungsmarkierung und nimmt die Änderung in das Dokument auf. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| reject() | Lehnt die nachverfolgte Änderung ab. Die Überarbeitungsmarkierungen werden entfernt, wobei der Originaltext erhalten bleibt. |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Details zur Eigenschaft
author
Ruft den Namen des Benutzers ab, der die nachverfolgte Änderung vorgenommen hat.
readonly author: string;Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
date
Ruft das Datum und die Uhrzeit ab, zu der die nachverfolgte Änderung vorgenommen wurde.
readonly date: Date;Eigenschaftswert
Date
Hinweise
formatDescription
Ruft die Beschreibung der nachverfolgten Formatierungsänderungen in der Revision ab.
readonly formatDescription: string;Eigenschaftswert
string
Hinweise
index
Ruft eine Zahl ab, die die Position dieses Elements in einer Sammlung darstellt.
readonly index: number;Eigenschaftswert
number
Hinweise
movedRange
Ruft ein Range Objekt ab, das den Textbereich darstellt, der mit verfolgten Änderungen von einer Stelle zur anderen im Dokument verschoben wurde.
readonly movedRange: Word.Range;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/track-moved-text.yaml
// Reads and selects the text associated with a tracked move.
await Word.run(async (context) => {
const document: Word.Document = context.document;
const revisions: Word.RevisionCollection = document.revisions;
revisions.load("items/type");
await context.sync();
const movedFrom: Word.RevisionType = Word.RevisionType.movedFrom;
const movedTo: Word.RevisionType = Word.RevisionType.movedTo;
const movedRevision: Word.Revision | undefined = revisions.items.find(
(revision: Word.Revision) => revision.type === movedFrom || revision.type === movedTo
);
if (!movedRevision) {
console.log("Revision types found:", revisions.items.map((revision: Word.Revision) => revision.type));
console.warn("No tracked move was found. Move an entire paragraph as described in the task pane; moving a phrase may produce insertion and deletion revisions instead.");
return;
}
const movedRange: Word.Range = movedRevision.movedRange;
movedRange.load("text");
movedRange.select();
await context.sync();
console.log(`Moved revision range text: ${movedRange.text}`);
});
range
Ruft ein Range Objekt ab, das den Teil des Dokuments darstellt, der in einer Überarbeitungsmarke enthalten ist.
readonly range: Word.Range;Eigenschaftswert
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml
// Reads and selects the text affected by the first revision.
await Word.run(async (context) => {
const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
const revisions: Word.RevisionCollection = paragraphRange.revisions;
revisions.load("items");
await context.sync();
if (revisions.items.length === 0) {
console.warn("No revisions were found. Run Set up to create tracked changes.");
return;
}
const firstRevision: Word.Revision = revisions.items[0];
const revisionRange: Word.Range = firstRevision.range;
revisionRange.load("text");
revisionRange.select();
await context.sync();
console.log(`First revision range text: ${revisionRange.text}`);
});
type
Ruft den Revisionstyp ab.
readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete";Eigenschaftswert
Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"
Hinweise
Details zur Methode
accept()
Akzeptiert die nachverfolgte Änderung, entfernt die Überarbeitungsmarkierung und nimmt die Änderung in das Dokument auf.
accept(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml
// Incorporates the first revision into the document.
await Word.run(async (context) => {
const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
const revisions: Word.RevisionCollection = paragraphRange.revisions;
revisions.load("items");
await context.sync();
if (revisions.items.length === 0) {
console.warn("No revisions were found. Run Set up to create tracked changes.");
return;
}
const firstRevision: Word.Revision = revisions.items[0];
firstRevision.accept();
await context.sync();
console.log("Accepted the first revision. Get revision metadata to inspect the remaining revisions.");
});
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.RevisionLoadOptions): Word.Revision;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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.Revision;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.Revision;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
reject()
Lehnt die nachverfolgte Änderung ab. Die Überarbeitungsmarkierungen werden entfernt, wobei der Originaltext erhalten bleibt.
reject(): void;Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-tracked-changes.yaml
// Removes the first revision and restores the original content.
await Word.run(async (context) => {
const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
const revisions: Word.RevisionCollection = paragraphRange.revisions;
revisions.load("items");
await context.sync();
if (revisions.items.length === 0) {
console.warn("No revisions were found. Run Set up to create tracked changes.");
return;
}
const firstRevision: Word.Revision = revisions.items[0];
firstRevision.reject();
await context.sync();
console.log("Rejected the first revision. Get revision metadata to inspect the remaining revisions.");
});
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.RevisionUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.Revision): void;Parameter
- properties
- Word.Revision
Gibt zurück
void
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 sie übergeben wird.) Während das ursprüngliche Word.Revision Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.RevisionData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.RevisionData;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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.Revision;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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Revision;