OfficeExtension.LoadOption interface

Pacote:

office

Especifica quais propriedades de um objeto devem ser carregadas. Essa carga acontece quando o método sync() é executado. Isso sincroniza os estados entre objetos do Office e objetos proxy JavaScript correspondentes.

Comentários

Para o Word, o método preferencial para especificar as propriedades e as informações de paginação é usando um literal de cadeia de caracteres. Os dois primeiros exemplos mostram a forma preferencial para solicitar as propriedades de texto e tamanho de fonte dos parágrafos em uma coleção de parágrafos:

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

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

Veja um exemplo parecido usando notação de objeto (inclui paginação):

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

Observe que, quando não determinamos as propriedades específicas do objeto Font na instrução Select, a instrução de expansão em si indica que todas as propriedades da fonte são carregadas.

Exemplos

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

Propriedades

expand	Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especifica as propriedades de navegação a serem carregadas.
select	Uma cadeia de caracteres delimitada por vírgulas, ou matriz de cadeias de caracteres, que especifica as propriedades a serem carregadas.
skip	Somente utilizável em tipos de coleção. Especifica o número de itens na coleção que devem ser ignorados e não incluídos no resultado. Se a parte superior for especificada, o conjunto de resultados começará depois de ignorar o número especificado de itens.
top	Somente utilizável em tipos de coleção. Especifica o número máximo de itens da coleção que podem ser incluídos no resultado.

Detalhes da propriedade

expand

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especifica as propriedades de navegação a serem carregadas.

expand?: string | string[];

Valor da propriedade

string | string[]

select

Uma cadeia de caracteres delimitada por vírgulas, ou matriz de cadeias de caracteres, que especifica as propriedades a serem carregadas.

select?: string | string[];

Valor da propriedade

string | string[]

skip

Somente utilizável em tipos de coleção. Especifica o número de itens na coleção que devem ser ignorados e não incluídos no resultado. Se a parte superior for especificada, o conjunto de resultados começará depois de ignorar o número especificado de itens.

skip?: number;

Valor da propriedade

number

top

Somente utilizável em tipos de coleção. Especifica o número máximo de itens da coleção que podem ser incluídos no resultado.

top?: number;

Valor da propriedade

number

Exemplos

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