Compartilhar via


Word.Coauthoring class

Representa o Coauthoring objeto . Esta ação monitoriza as atualizações, alterações, conflitos e outras interações no documento efetuadas através da cocriação.

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Propriedades

authors

Obtém um CoauthorCollection objeto que representa todos os cocriadores atualmente a editar o documento.

canCoauthor

Obtém se este documento pode ser cocriado.

canMerge

Obtém se o documento pode ser intercalado automaticamente.

conflicts

Obtém um ConflictCollection objeto que representa todos os conflitos no documento.

context

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

locks

Obtém um CoauthoringLockCollection objeto que representa os bloqueios no documento.

me

Obtém um Coauthor objeto que representa o utilizador atual.

pendingUpdates

Obtém se o documento tem atualizações pendentes que não foram aceites.

updates

Obtém um CoauthoringUpdateCollection objeto que representa as atualizações mais recentes que foram intercaladas no documento.

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.

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

authors

Obtém um CoauthorCollection objeto que representa todos os cocriadores atualmente a editar o documento.

readonly authors: Word.CoauthorCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

canCoauthor

Obtém se este documento pode ser cocriado.

readonly canCoauthor: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

canMerge

Obtém se o documento pode ser intercalado automaticamente.

readonly canMerge: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

conflicts

Obtém um ConflictCollection objeto que representa todos os conflitos no documento.

readonly conflicts: Word.ConflictCollection;

Valor da propriedade

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

locks

Obtém um CoauthoringLockCollection objeto que representa os bloqueios no documento.

readonly locks: Word.CoauthoringLockCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

me

Obtém um Coauthor objeto que representa o utilizador atual.

readonly me: Word.Coauthor;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

pendingUpdates

Obtém se o documento tem atualizações pendentes que não foram aceites.

readonly pendingUpdates: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

updates

Obtém um CoauthoringUpdateCollection objeto que representa as atualizações mais recentes que foram intercaladas no documento.

readonly updates: Word.CoauthoringUpdateCollection;

Valor da propriedade

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.CoauthoringLoadOptions): Word.Coauthoring;

Parâmetros

options
Word.Interfaces.CoauthoringLoadOptions

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

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

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

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

toJSON(): Word.Interfaces.CoauthoringData;

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

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

Retornos