Compartilhar via


Word.Revision class

Representa uma única alteração registada num documento.

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Propriedades

author

Obtém o nome do utilizador que efetuou a 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 e hora em que a alteração registada foi efetuada.

formatDescription

Obtém a descrição das alterações de formatação registadas na revisão.

index

Obtém um número que representa a posição deste item numa coleção.

movedRange

Obtém um Range objeto que representa o intervalo de texto que foi movido de um local para outro no documento com alterações registadas.

range

Obtém um Range objeto que representa a parte do documento contida numa marca de revisão.

type

Obtém o tipo de revisão.

Métodos

accept()

Aceita a alteração registada, remove a marca de revisão e incorpora a alteração no documento.

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. As marcas de revisão são removidas, deixando o texto original intacto.

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

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.Revision é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.RevisionData) 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 nome do utilizador que efetuou a alteração registada.

readonly author: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

date

Obtém a data e hora em que a alteração registada foi efetuada.

readonly date: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

formatDescription

Obtém a descrição das alterações de formatação registadas na revisão.

readonly formatDescription: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

index

Obtém um número que representa a posição deste item numa coleção.

readonly index: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

movedRange

Obtém um Range objeto que representa o intervalo de texto que foi movido de um local para outro no documento com alterações registadas.

readonly movedRange: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

range

Obtém um Range objeto que representa a parte do documento contida numa marca de revisão.

readonly range: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

type

Obtém o tipo de revisão.

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";

Valor da propriedade

Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Detalhes do método

accept()

Aceita a alteração registada, remove a marca de revisão e incorpora a alteração no documento.

accept(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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.RevisionLoadOptions): Word.Revision;

Parâmetros

options
Word.Interfaces.RevisionLoadOptions

Fornece opções para as propriedades do objeto a 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.Revision;

Parâmetros

propertyNames

string | string[]

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

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.Revision;

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

reject()

Rejeita a alteração registada. As marcas de revisão são removidas, deixando o texto original intacto.

reject(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Word.Interfaces.RevisionUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.Revision): void;

Parâmetros

properties
Word.Revision

Retornos

void

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.Revision é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.RevisionData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.RevisionData;

Retornos

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.Revision;

Retornos

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.Revision;

Retornos