Word.CoauthoringLockCollection class

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Word.CoauthoringLock[];

Eigenschaftswert

Gibt ein CoauthoringLock Objekt zurück, das eine Sperre darstellt, die einem angegebenen Bereich hinzugefügt wurde.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Diese API funktioniert nur mit älteren Sperren für die gemeinsame Dokumenterstellung. Sie gilt nicht für moderne OneDrive- oder SharePoint-Co-Authoring, wo die Sperrverwaltung automatisch vom Dienst übernommen wird. Aufrufe eines modernen Dokuments schlagen mit einem GeneralException Fehler fehl.

Beispiele

// 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.");
});

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Word.CoauthoringLockCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.CoauthoringLockCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): Word.Interfaces.CoauthoringLockCollectionData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.

track(): Word.CoauthoringLockCollection;

Gibt zurück

Entfernt alle kurzlebigen Sperren aus dem Dokument.

unlockEphemeralLocks(): void;

Gibt zurück

Hinweise

API-Satz: WordApiDesktop 1.4

Diese API funktioniert nur mit älteren Sperren für die gemeinsame Dokumenterstellung. Sie gilt nicht für moderne OneDrive- oder SharePoint-Co-Authoring, wo die Sperrverwaltung automatisch vom Dienst übernommen wird. Aufrufe eines modernen Dokuments schlagen mit einem GeneralException Fehler fehl.

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.CoauthoringLockCollection;

Gibt zurück