Compartilhar via

Word.TrackedChange class

  • Referência
Pacote:
word

Representa uma alteração registada num documento Word.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.6 ]

Exemplos

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

Propriedades

author

Obtém o autor da alteração registada.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
date

Obtém a data da alteração registada.
text

Obtém o texto da alteração registada.
type

Obtém o tipo de alteração registada.

Métodos

accept()

Aceita a alteração registada.
getNext()

Obtém a próxima alteração registada. Gera um ItemNotFound erro se esta alteração registada for a última.
getNextOrNullObject()

Obtém a próxima alteração registada. Se esta alteração registada for a última, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getRange(rangeLocation)

Obtém o intervalo da alteração registada.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
reject()

Rejeita a alteração registada.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.TrackedChange é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TrackedChangeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

author

Obtém o autor da alteração registada.

readonly author: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.6 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

date

Obtém a data da alteração registada.

readonly date: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: WordApi 1.6 ]

text

Obtém o texto da alteração registada.

readonly text: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.6 ]

type

Obtém o tipo de alteração registada.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApi 1.6 ]

Detalhes do método

accept()

Aceita a alteração registada.

accept(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.6 ]

Exemplos

// 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.");
});

getNext()

Obtém a próxima alteração registada. Gera um ItemNotFound erro se esta alteração registada for a última.

getNext(): Word.TrackedChange;

Retornos

Word.TrackedChange

Comentários

[ Conjunto de API: WordApi 1.6 ]

Exemplos

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

getNextOrNullObject()

Obtém a próxima alteração registada. Se esta alteração registada for a última, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getNextOrNullObject(): Word.TrackedChange;

Retornos

Word.TrackedChange

Comentários

[ Conjunto de API: WordApi 1.6 ]

getRange(rangeLocation)

Obtém o intervalo da alteração registada.

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

Parâmetros

rangeLocation

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

Retornos

Word.Range

Comentários

[ Conjunto de API: WordApi 1.6 ]

Exemplos

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

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options
Word.Interfaces.TrackedChangeLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.TrackedChange

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Word.TrackedChange

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Word.TrackedChange

reject()

Rejeita a alteração registada.

reject(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.6 ]

Exemplos

// 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.");
});

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.TrackedChange é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TrackedChangeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.TrackedChangeData;

Retornos

Word.Interfaces.TrackedChangeData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.TrackedChange;

Retornos

Word.TrackedChange

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.TrackedChange;

Retornos

Word.TrackedChange