OfficeExtension.LoadOption interface

Paket:

office

Gibt an, welche Eigenschaften eines Objekts geladen werden sollen. Diese Last tritt auf, wenn die sync()-Methode ausgeführt wird. Dadurch werden die Zustände zwischen Office-Objekten und entsprechenden JavaScript-Proxyobjekten synchronisiert.

Hinweise

Für Word ist die bevorzugte Methode zum Angeben der Eigenschaften und Paginginformationen die Verwendung eines Zeichenfolgenliterals. In den folgenden zwei Beispielen wird die bevorzugte Methode zum Anfordern der Text- und Schriftgradeigenschaften für Absätze in einer Absatzsammlung dargestellt:

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

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

Hier sehen Sie ein ähnliches Beispiel mit Objektnotation (einschließlich Paging):

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

Hinweis: Wenn keine bestimmten Eigenschaften des Schriftartenobjekts in der select-Anweisung angegeben sind, gibt die expand-Anweisung an, dass alle Schriftarteneigenschaften geladen werden.

Beispiele

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

Eigenschaften

expand	Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Navigationseigenschaften angibt.
select	Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angibt.
skip	Kann nur für Sammlungstypen verwendet werden. Gibt die Anzahl der Elemente in der Auflistung an, die übersprungen und nicht in das Ergebnis einbezogen werden sollen. Wenn top angegeben ist, beginnt das Resultset, nachdem die angegebene Anzahl von Elementen übersprungen wurde.
top	Kann nur für Sammlungstypen verwendet werden. Gibt die maximale Anzahl der Sammlungselemente an, die im Ergebnis enthalten sein können.

Details zur Eigenschaft

expand

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Navigationseigenschaften angibt.

expand?: string | string[];

Eigenschaftswert

string | string[]

select

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angibt.

select?: string | string[];

Eigenschaftswert

string | string[]

skip

Kann nur für Sammlungstypen verwendet werden. Gibt die Anzahl der Elemente in der Auflistung an, die übersprungen und nicht in das Ergebnis einbezogen werden sollen. Wenn top angegeben ist, beginnt das Resultset, nachdem die angegebene Anzahl von Elementen übersprungen wurde.

skip?: number;

Eigenschaftswert

number

top

Kann nur für Sammlungstypen verwendet werden. Gibt die maximale Anzahl der Sammlungselemente an, die im Ergebnis enthalten sein können.

top?: number;

Eigenschaftswert

number

Beispiele

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