OfficeExtension.LoadOption interface

Paquet:

office

Spécifie les propriétés d’un objet qui doivent être chargées. Cette charge se produit lorsque la méthode sync() est exécutée. Cela synchronise les états entre les objets Office et les objets proxy JavaScript correspondants.

Remarques

Pour Word, la méthode préférée pour spécifier les propriétés et les informations de pagination consiste à utiliser un littéral de chaîne. Les deux premiers exemples illustrent la méthode recommandée pour demander les propriétés de texte et de taille de police pour les paragraphes d’une collection :

context.load(paragraphs, 'text, font/size');

paragraphs.load('text, font/size');

Voici un exemple similaire qui utilise la notation d’objet (y compris la pagination) :

context.load(paragraphs, {select: 'text, font/size', expand: 'font', top: 50, skip: 0});

paragraphs.load({select: 'text, font/size', expand: 'font', top: 50, skip: 0});

Notez que si aucune propriété spécifique n’est définie pour l’objet de police dans l’instruction select, l’instruction expand, si elle est définie seule, indique que toutes les propriétés de police sont chargées.

Exemples

// This example shows how to get the paragraphs in the Word document
// along with their text and font size properties.

// Run a batch operation against the Word object model.
Word.run(function (context) {
    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the text and font properties.
    // It is best practice to always specify the property set.
    // Otherwise, all properties are returned on the object.
    context.load(paragraphs, 'text, font/size');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        // Insert code that works with the paragraphs loaded by context.load().
    })
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

Propriétés

expand	Chaîne délimitée par des virgules, ou tableau de chaînes, qui spécifie les propriétés de navigation à charger.
select	Chaîne délimitée par des virgules, ou tableau de chaînes, qui spécifie les propriétés à charger.
skip	Utilisable uniquement sur les types de collection. Spécifie le nombre d’éléments de la collection qui doivent être ignorés et non inclus dans le résultat. Si top est spécifié, le jeu de résultats démarre après avoir ignoré le nombre spécifié d’éléments.
top	Utilisable uniquement sur les types de collection. Spécifie le nombre maximal d’éléments de collection qui peuvent être inclus dans le résultat.

Détails de la propriété

expand

Chaîne délimitée par des virgules, ou tableau de chaînes, qui spécifie les propriétés de navigation à charger.

expand?: string | string[];

Valeur de propriété

string | string[]

select

Chaîne délimitée par des virgules, ou tableau de chaînes, qui spécifie les propriétés à charger.

select?: string | string[];

Valeur de propriété

string | string[]

skip

Utilisable uniquement sur les types de collection. Spécifie le nombre d’éléments de la collection qui doivent être ignorés et non inclus dans le résultat. Si top est spécifié, le jeu de résultats démarre après avoir ignoré le nombre spécifié d’éléments.

skip?: number;

Valeur de propriété

number

top

Utilisable uniquement sur les types de collection. Spécifie le nombre maximal d’éléments de collection qui peuvent être inclus dans le résultat.

top?: number;

Valeur de propriété

number

Exemples

// This OneNote example shows how to get the page title and indentation level
// of the top five pages in the current section.
OneNote.run(function (context) {
    // Get the pages in the current section.
    const pages = context.application.getActiveSection().pages;

    // Queue a command to load the pages.           
    pages.load({ "select":"title,pageLevel", "top":5, "skip":0 });
    return context.sync()
        .then(function() {
            // Iterate through the collection of pages.    
            $.each(pages.items, function(index, page) {
                // Show some properties.
                console.log("Page title: " + page.title);
                console.log("Indentation level: " + page.pageLevel);
            });
        }).catch(function(error) {
            console.log("Error: " + error);
            if (error instanceof OfficeExtension.Error) {
                console.log("Debug info: " + JSON.stringify(error.debugInfo));
            }
        })
    });