Word.TrackedChange class

  • Référence
Paquet:
word

Représente une modification suivie dans un document Word.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Propriétés

author

Obtient l’auteur de la modification suivie.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
date

Obtient la date de la modification suivie.
text

Obtient le texte de la modification suivie.
type

Obtient le type de la modification suivie.

Méthodes

accept()

Accepte la modification suivie.
getNext()

Obtient la modification suivie suivante. Génère une ItemNotFound erreur si cette modification suivie est la dernière.
getNextOrNullObject()

Obtient la modification suivie suivante. Si cette modification suivie est la dernière, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getRange(rangeLocation)

Obtient la plage de la modification suivie.
load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
reject()

Rejette la modification suivie.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet TrackedChange est un objet API. La toJSON méthode renvoie un objet JavaScript brut (tapé en tant Word.Interfaces.TrackedChangeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

author

Obtient l’auteur de la modification suivie.

readonly author: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.6 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

date

Obtient la date de la modification suivie.

readonly date: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : WordApi 1.6 ]

text

Obtient le texte de la modification suivie.

readonly text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.6 ]

type

Obtient le type de la modification suivie.

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

Valeur de propriété

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

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Détails de la méthode

accept()

Accepte la modification suivie.

accept(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// 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()

Obtient la modification suivie suivante. Génère une ItemNotFound erreur si cette modification suivie est la dernière.

getNext(): Word.TrackedChange;

Retours

Word.TrackedChange

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// 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()

Obtient la modification suivie suivante. Si cette modification suivie est la dernière, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getNextOrNullObject(): Word.TrackedChange;

Retours

Word.TrackedChange

Remarques

[ Ensemble d’API : WordApi 1.6 ]

getRange(rangeLocation)

Obtient la plage de la modification suivie.

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

Paramètres

rangeLocation

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

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// 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)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

options
Word.Interfaces.TrackedChangeLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.TrackedChange

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.TrackedChange

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

propertyNamesAndPaths

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

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.TrackedChange

reject()

Rejette la modification suivie.

reject(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// 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()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet TrackedChange est un objet API. La toJSON méthode renvoie un objet JavaScript brut (tapé en tant Word.Interfaces.TrackedChangeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.TrackedChangeData;

Retours

Word.Interfaces.TrackedChangeData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.TrackedChange;

Retours

Word.TrackedChange

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.TrackedChange;

Retours

Word.TrackedChange