Word.TrackedChange class
Representa uma alteração controlada em um documento Word.
- Extends
Comentários
[ Conjunto de API: WordApi 1.6 ]
Propriedades
author | Obtém o autor da alteração rastreada. |
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
date | Obtém a data da alteração rastreada. |
text | Obtém o texto da alteração rastreada. |
type | Obtém o tipo da alteração rastreada. |
Métodos
accept() | Aceita a alteração rastreada. |
get |
Obtém a próxima alteração rastreada. Gerará um |
get |
Obtém a próxima alteração rastreada. Se essa alteração rastreada for a última, esse método retornará um objeto com sua |
get |
Obtém o intervalo da alteração rastreada. |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
reject() | Rejeita a alteração rastreada. |
toJSON() | Substitui o método JavaScript |
track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre |
untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar |
Detalhes da propriedade
author
Obtém o autor da alteração rastreada.
readonly author: string;
Valor da propriedade
string
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;
Valor da propriedade
date
Obtém a data da alteração rastreada.
readonly date: Date;
Valor da propriedade
Date
Comentários
text
Obtém o texto da alteração rastreada.
readonly text: string;
Valor da propriedade
string
Comentários
type
Obtém o tipo da alteração rastreada.
readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
Valor da propriedade
Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"
Comentários
Detalhes do método
accept()
Aceita a alteração rastreada.
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 = context.document.body;
const trackedChanges = body.getTrackedChanges();
const 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 rastreada. Gerará um ItemNotFound
erro se essa alteração rastreada for a última.
getNext(): Word.TrackedChange;
Retornos
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 = 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()
Obtém a próxima alteração rastreada. Se essa alteração rastreada for a última, esse método retornará um objeto com sua isNullObject
propriedade definida como true
. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getNextOrNullObject(): Word.TrackedChange;
Retornos
Comentários
getRange(rangeLocation)
Obtém o intervalo da alteração rastreada.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
Parâmetros
Retornos
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 = 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)
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
Fornece opções para quais propriedades do objeto carregar.
Retornos
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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
reject()
Rejeita a alteração rastreada.
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 = context.document.body;
const trackedChanges = body.getTrackedChanges();
const 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 é passado para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que é passado para ele.) Enquanto o Word original. O objeto TrackedChange é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Word.Interfaces.TrackedChangeData
) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.
toJSON(): Word.Interfaces.TrackedChangeData;
Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
track(): Word.TrackedChange;
Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync()
antes que a versão da memória entre em vigor.
untrack(): Word.TrackedChange;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de