Word.CoauthoringLock class
Representa um bloqueio de cocriação num documento Word.
- Extends
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. |
| owner | Obtém o proprietário do bloqueio. |
| range | Obtém um |
| type | Obtém um |
Métodos
| 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 |
| 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 |
| 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 |
| unlock() | Remove este bloqueio, mesmo que pertença a um utilizador diferente. |
| 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 |
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
owner
Obtém o proprietário do bloqueio.
readonly owner: Word.Coauthor;Valor da propriedade
Comentários
range
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
type
Obtém um CoauthoringLockType valor que representa o tipo de bloqueio.
readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed";Valor da propriedade
Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"
Comentários
Conjunto de API: WordApiDesktop 1.4
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-locks.yaml
// Gets all coauthoring locks in the document.
await Word.run(async (context) => {
const locks: Word.CoauthoringLockCollection = context.document.coauthoring.locks;
locks.load("items/type");
await context.sync();
if (locks.items.length === 0) {
console.log("No locks found in the document.");
return;
}
console.log(`Found ${locks.items.length} lock(s) in the document:`);
for (let i = 0; i < locks.items.length; i++) {
const lock: Word.CoauthoringLock = locks.items[i];
console.log(` Lock ${i + 1}: type = ${lock.type}`);
}
});
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.CoauthoringLockLoadOptions): Word.CoauthoringLock;Parâmetros
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.CoauthoringLock;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.CoauthoringLock;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.CoauthoringLockUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Word.Interfaces.CoauthoringLockUpdateData
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.CoauthoringLock): void;Parâmetros
- properties
- Word.CoauthoringLock
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.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
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.CoauthoringLock;Retornos
unlock()
Remove este bloqueio, mesmo que pertença a um utilizador diferente.
unlock(): void;Retornos
void
Comentários
Conjunto de API: WordApiDesktop 1.4
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-locks.yaml
// Removes the first coauthoring lock found in the document.
await Word.run(async (context) => {
const locks: Word.CoauthoringLockCollection = context.document.coauthoring.locks;
locks.load("items");
await context.sync();
if (locks.items.length === 0) {
console.log("No locks found to remove.");
return;
}
locks.items[0].unlock();
await context.sync();
console.log("First lock removed.");
});
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.CoauthoringLock;