OfficeExtension.TrackedObjects class

Suivez un nouvel objet pour l’ajustement automatique en fonction des modifications environnantes dans le document. Seuls certains types d’objets le requièrent. Si vous utilisez un objet dans les appels « .sync » 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 deviez avoir ajouté l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection dans Word, vous devez également suivre la collection parente.

add(object: ClientObject): void;

Paramètres

Retours

Exemples

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

Suivez un ensemble d’objets pour les ajuster automatiquement en fonction des modifications environnantes du document. Seuls certains types d’objets le requièrent. Si vous utilisez un objet dans les appels « .sync » 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 deviez avoir ajouté l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection dans Word, vous devez également suivre la collection parente.

add(objects: ClientObject[]): void;

Paramètres

Retours

Si l’objet proxy donné se trouve déjà dans cette collection, cette méthode libère la mémoire associée à l’objet. Vous devez appeler context.sync() avant que la libération de mémoire ne prenne effet. Si l’objet proxy donné ne figure pas dans cette collection, il n’est pas stocké après context.sync() l’appel. Cela accélère les instances où de nombreux objets sont créés pour des opérations à usage unique.

remove(object: ClientObject): void;

Paramètres

Retours

Exemples

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

Si les objets proxy donnés se trouvent déjà dans cette collection, cette méthode libère la mémoire associée aux objets. Vous devez appeler context.sync() avant que la libération de mémoire ne prenne effet. Si les objets proxy donnés ne se trouvent pas dans cette collection, les objets proxy ne seront pas stockés après context.sync() l’appel. Cela accélère les instances où de nombreux objets sont créés pour des opérations à usage unique.

remove(objects: ClientObject[]): void;

Paramètres

Retours