OfficeExtension.LoadOption interface

Paquete:

office

Especifica qué propiedades de un objeto se deben cargar. Esta carga se produce cuando se ejecuta el método sync(). Esto sincroniza los estados entre los objetos de Office y los objetos de proxy de JavaScript correspondientes.

Comentarios

Para Word, el método preferido para especificar las propiedades y la información de paginación es mediante un literal de cadena. Los dos primeros ejemplos muestran la forma preferida para solicitar las propiedades de tamaño de fuente y texto de los párrafos en una colección de párrafo:

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

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

Aquí hay un ejemplo parecido que usa la notación de objetos (incluye la paginación):

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

Tenga en cuenta que si no especificamos las propiedades específicas del objeto de fuente en la instrucción Select, la instrucción Expand indicaría que están cargadas todas las propiedades de fuente.

Ejemplos

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

Propiedades

expand	Cadena delimitada por comas, o matriz de cadenas, que especifica las propiedades de navegación que se van a cargar.
select	Cadena delimitada por comas, o matriz de cadenas, que especifica las propiedades que se van a cargar.
skip	Solo se puede usar en tipos de colección. Especifica el número de elementos de la colección que se omitirán y no se incluirán en el resultado. Si se especifica top, el conjunto de resultados se iniciará después de omitir el número especificado de elementos.
top	Solo se puede usar en tipos de colección. Especifica el número máximo de elementos de colección que pueden incluirse en el resultado.

Detalles de las propiedades

expand

Cadena delimitada por comas, o matriz de cadenas, que especifica las propiedades de navegación que se van a cargar.

expand?: string | string[];

Valor de propiedad

string | string[]

select

Cadena delimitada por comas, o matriz de cadenas, que especifica las propiedades que se van a cargar.

select?: string | string[];

Valor de propiedad

string | string[]

skip

Solo se puede usar en tipos de colección. Especifica el número de elementos de la colección que se omitirán y no se incluirán en el resultado. Si se especifica top, el conjunto de resultados se iniciará después de omitir el número especificado de elementos.

skip?: number;

Valor de propiedad

number

top

Solo se puede usar en tipos de colección. Especifica el número máximo de elementos de colección que pueden incluirse en el resultado.

top?: number;

Valor de propiedad

number

Ejemplos

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