OfficeExtension.TrackedObjects class

Paket:: office

Sammlung von verfolgten Objekten, die in einem Anforderungskontext enthalten sind. Weitere Informationen finden Sie unter context.trackedObjects .

Hinweise

Verwendet von

OfficeExtension.ClientRequestContext: trackedObjects

Beispiele

// This sample creates many one-cell ranges, then removes each
// cell proxy object from memory before the batch operation completes.
await Excel.run(async (context) => {
    const largeRange = context.workbook.getSelectedRange();
    largeRange.load(["rowCount", "columnCount"]);
    await context.sync();

    const trackedObjects: OfficeExtension.TrackedObjects = context.trackedObjects;

    for (let i = 0; i < largeRange.rowCount; i++) {
        for (let j = 0; j < largeRange.columnCount; j++) {
            const cell = largeRange.getCell(i, j);
            cell.values = [[i *j]];

            // Release the cell proxy object from memory now that we're
            // done with it. The memory is freed on the next context.sync() call.
            trackedObjects.remove(cell);
        }
    }

    await context.sync();
});

Methoden

add(object)	Verfolgen Sie ein neues Objekt zur automatischen Anpassung basierend auf Umgebungsänderungen im Dokument. Nur einige Objekttypen erfordern dies. Wenn Sie ein Objekt für ".sync"-Aufrufe 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, muss das Objekt bei der ersten Erstellung des Objekts der Sammlung für verfolgte Objekte hinzugefügt worden sein. Wenn dieses Objekt Teil einer Sammlung in Word ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
add(objects)	Verfolgen Sie eine Reihe von Objekten für die automatische Anpassung basierend auf Umgebungsänderungen im Dokument. Nur einige Objekttypen erfordern dies. Wenn Sie ein Objekt für ".sync"-Aufrufe 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, muss das Objekt bei der ersten Erstellung des Objekts der Sammlung für verfolgte Objekte hinzugefügt worden sein. Wenn dieses Objekt Teil einer Sammlung in Word ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
remove(object)	Wenn sich das angegebene Proxyobjekt bereits in dieser Auflistung befindet, gibt diese Methode den dem Objekt zugeordneten Speicher frei. Sie müssen anrufen `context.sync()` , bevor die Speicherfreigabe wirksam wird. Wenn sich das angegebene Proxyobjekt nicht in dieser Auflistung befindet, wird das Proxyobjekt nach `context.sync()` dem Aufruf nicht gespeichert. Dadurch werden Instanzen beschleunigt, in denen viele Objekte für die einmalige Verwendung erstellt werden.
remove(objects)	Wenn sich die angegebenen Proxyobjekte bereits in dieser Auflistung befinden, gibt diese Methode den mit den Objekten verknüpften Speicher frei. Sie müssen anrufen `context.sync()` , bevor die Speicherfreigabe wirksam wird. Wenn sich die angegebenen Proxyobjekte nicht in dieser Auflistung befinden, werden die Proxyobjekte nach `context.sync()` dem Aufruf nicht gespeichert. Dadurch werden Instanzen beschleunigt, in denen viele Objekte für die einmalige Verwendung erstellt werden.

Details zur Methode

add(object)

Verfolgen Sie ein neues Objekt zur automatischen Anpassung basierend auf Umgebungsänderungen im Dokument. Nur einige Objekttypen erfordern dies. Wenn Sie ein Objekt für ".sync"-Aufrufe 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, muss das Objekt bei der ersten Erstellung des Objekts der Sammlung für verfolgte Objekte hinzugefügt worden sein. Wenn dieses Objekt Teil einer Sammlung in Word ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.

add(object: ClientObject): void;

Parameter

object: OfficeExtension.ClientObject

Gibt zurück

void

Beispiele

// This sample shows how to track a Word proxy object so it can be used
// across multiple context.sync() calls.
await Word.run(async (context) => {
    // Create a paragraph proxy object.
    const paragraph = context.document.body.insertParagraph(
        "This paragraph is tracked across sync calls.",
        Word.InsertLocation.end
    );

    // Track the paragraph so it remains valid across sync calls.
    context.trackedObjects.add(paragraph);
    await context.sync();

    // The tracked paragraph can still be used after the preceding sync.
    paragraph.font.bold = true;
    await context.sync();

    // Remember to release the object from memory once you're done with it.
    context.trackedObjects.remove(paragraph);
    await context.sync();
});

add(objects)

Verfolgen Sie eine Reihe von Objekten für die automatische Anpassung basierend auf Umgebungsänderungen im Dokument. Nur einige Objekttypen erfordern dies. Wenn Sie ein Objekt für ".sync"-Aufrufe 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, muss das Objekt bei der ersten Erstellung des Objekts der Sammlung für verfolgte Objekte hinzugefügt worden sein. Wenn dieses Objekt Teil einer Sammlung in Word ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.

add(objects: ClientObject[]): void;

Parameter

objects: OfficeExtension.ClientObject[]

Gibt zurück

void

remove(object)

Wenn sich das angegebene Proxyobjekt bereits in dieser Auflistung befindet, gibt diese Methode den dem Objekt zugeordneten Speicher frei. Sie müssen anrufen context.sync() , bevor die Speicherfreigabe wirksam wird. Wenn sich das angegebene Proxyobjekt nicht in dieser Auflistung befindet, wird das Proxyobjekt nach context.sync() dem Aufruf nicht gespeichert. Dadurch werden Instanzen beschleunigt, in denen viele Objekte für die einmalige Verwendung erstellt werden.

remove(object: ClientObject): void;

Parameter

object: OfficeExtension.ClientObject

Gibt zurück

void

Beispiele

// This sample inserts many paragraphs into a Word document, removing each
// paragraph proxy object from memory after it's used.
await Word.run(async (context) => {
    const body = context.document.body;

    for (let i = 0; i < 500; i++) {
        const paragraph = body.insertParagraph(`Paragraph ${i}`, Word.InsertLocation.end);

        // Release the paragraph proxy object from memory now that we're
        // done with it. The memory is freed on the next context.sync() call.
        context.trackedObjects.remove(paragraph);
    }

    await context.sync();
});

remove(objects)

Wenn sich die angegebenen Proxyobjekte bereits in dieser Auflistung befinden, gibt diese Methode den mit den Objekten verknüpften Speicher frei. Sie müssen anrufen context.sync() , bevor die Speicherfreigabe wirksam wird. Wenn sich die angegebenen Proxyobjekte nicht in dieser Auflistung befinden, werden die Proxyobjekte nach context.sync() dem Aufruf nicht gespeichert. Dadurch werden Instanzen beschleunigt, in denen viele Objekte für die einmalige Verwendung erstellt werden.

remove(objects: ClientObject[]): void;

Parameter

objects: OfficeExtension.ClientObject[]

Gibt zurück

void

Feedback

War diese Seite hilfreich?