Word.TrackedChangeCollection class
Contém uma coleção de Word. Objetos TrackedChange.
- Extends
Comentários
[ Conjunto de API: WordApi 1.6 ]
Propriedades
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
items | Obtém os itens filhos carregados nesta coleção. |
Métodos
accept |
Aceita todas as alterações rastreadas na coleção. |
get |
Obtém o primeiro TrackedChange nesta coleção. Gerará um |
get |
Obtém o primeiro TrackedChange nesta coleção. Se essa coleção estiver vazia, esse método retornará um objeto com sua |
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 todas as alterações rastreadas na coleção. |
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
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Word.TrackedChange[];
Valor da propriedade
Detalhes do método
acceptAll()
Aceita todas as alterações rastreadas na coleção.
acceptAll(): 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 all tracked changes.
await Word.run(async (context) => {
const body = context.document.body;
const trackedChanges = body.getTrackedChanges();
trackedChanges.acceptAll();
console.log("Accepted all tracked changes");
});
getFirst()
Obtém o primeiro TrackedChange nesta coleção. Gerará um ItemNotFound
erro se essa coleção estiver vazia.
getFirst(): 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 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);
});
getFirstOrNullObject()
Obtém o primeiro TrackedChange nesta coleção. Se essa coleção estiver vazia, esse método retornará um objeto com sua isNullObject
propriedade definida como true
. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getFirstOrNullObject(): Word.TrackedChange;
Retornos
Comentários
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.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection;
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.TrackedChangeCollection;
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?: OfficeExtension.LoadOption): Word.TrackedChangeCollection;
Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
rejectAll()
Rejeita todas as alterações rastreadas na coleção.
rejectAll(): 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 all tracked changes.
await Word.run(async (context) => {
const body = context.document.body;
const trackedChanges = body.getTrackedChanges();
trackedChanges.rejectAll();
console.log("Rejected all tracked changes");
});
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.) Considerando que o objeto original Word.TrackedChangeCollection
é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Word.Interfaces.TrackedChangeCollectionData
) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Word.Interfaces.TrackedChangeCollectionData;
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.TrackedChangeCollection;
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.TrackedChangeCollection;
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