Word.CoauthoringLockCollection class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Word.CoauthoringLock[];

Valeur de propriété

Renvoie un CoauthoringLock objet qui représente un verrou ajouté à une plage spécifiée.

add(options?: Word.CoauthoringLockAddOptions): Word.CoauthoringLock;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Cette API fonctionne uniquement avec les verrous de co-création hérités. Elle ne s’applique pas à la co-création moderne de OneDrive ou de SharePoint, où la gestion des verrous est gérée automatiquement par le service. Les appels sur un document moderne échouent avec une GeneralException erreur.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-locks.yaml

// Adds a lock to the paragraph at the insertion point.
// Requires the document to be saved to OneDrive or SharePoint.
await Word.run(async (context) => {
  const coauthoring: Word.Coauthoring = context.document.coauthoring;
  coauthoring.load("canCoauthor");
  await context.sync();

  if (!coauthoring.canCoauthor) {
    console.warn("This document doesn't support coauthoring. Save it to OneDrive or SharePoint and try again.");
    return;
  }

  const locks: Word.CoauthoringLockCollection = coauthoring.locks;
  locks.add();
  await context.sync();

  console.log("Lock added.");
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.CoauthoringLockCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthoringLockCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.CoauthoringLockCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CoauthoringLockCollection;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.CoauthoringLockCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.CoauthoringLockCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Word.Interfaces.CoauthoringLockCollectionData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.CoauthoringLockCollection;

Retours

Supprime tous les verrous éphémères du document.

unlockEphemeralLocks(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Cette API fonctionne uniquement avec les verrous de co-création hérités. Elle ne s’applique pas à la co-création moderne de OneDrive ou de SharePoint, où la gestion des verrous est gérée automatiquement par le service. Les appels sur un document moderne échouent avec une GeneralException erreur.

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.CoauthoringLockCollection;

Retours