Compartilhar via


Word.RevisionsFilter class

Representa as definições atuais relacionadas com a apresentação de comentários e marcas de revisão dos revisores no documento.

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Propriedades

context

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

markup

Especifica um RevisionsMarkup valor que representa a extensão da margem de lucro do revisor apresentada no documento.

reviewers

Obtém o ReviewerCollection objeto que representa a coleção de revisores de um ou mais documentos.

view

Especifica um RevisionsView valor que representa globalmente se Word apresenta a versão original do documento ou a versão final, que poderá ter revisões e alterações de formatação aplicadas.

Métodos

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.

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.

toggleShowAllReviewers()

Mostra ou oculta todas as revisões no documento que contêm comentários e alterações registadas.

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.RevisionsFilter é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.RevisionsFilterData) 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

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

markup

Especifica um RevisionsMarkup valor que representa a extensão da margem de lucro do revisor apresentada no documento.

markup: Word.RevisionsMarkup | "None" | "Simple" | "All";

Valor da propriedade

Word.RevisionsMarkup | "None" | "Simple" | "All"

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

reviewers

Obtém o ReviewerCollection objeto que representa a coleção de revisores de um ou mais documentos.

readonly reviewers: Word.ReviewerCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

view

Especifica um RevisionsView valor que representa globalmente se Word apresenta a versão original do documento ou a versão final, que poderá ter revisões e alterações de formatação aplicadas.

view: Word.RevisionsView | "Final" | "Original";

Valor da propriedade

Word.RevisionsView | "Final" | "Original"

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Detalhes do método

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.RevisionsFilterLoadOptions): Word.RevisionsFilter;

Parâmetros

options
Word.Interfaces.RevisionsFilterLoadOptions

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

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

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

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.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Word.Interfaces.RevisionsFilterUpdateData

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.RevisionsFilter): void;

Parâmetros

Retornos

void

toggleShowAllReviewers()

Mostra ou oculta todas as revisões no documento que contêm comentários e alterações registadas.

toggleShowAllReviewers(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

toJSON(): Word.Interfaces.RevisionsFilterData;

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

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

Retornos