Word.CoauthoringLock class

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

Obtém o proprietário do bloqueio.

readonly owner: Word.Coauthor;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém um Range objeto que representa a parte do documento que está contida no CoauthoringLock objeto.

readonly range: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém um CoauthoringLockType valor que representa o tipo de bloqueio.

readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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.CoauthoringLockLoadOptions): Word.CoauthoringLock;

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros

Retornos

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

set(properties: Word.CoauthoringLock): void;

Parâmetros

Retornos

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

toJSON(): Word.Interfaces.CoauthoringLockData;

Retornos

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

Retornos

Remove este bloqueio, mesmo que pertença a um utilizador diferente.

unlock(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos