OneNote.PageCollection class

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Retorna o número de páginas da coleção.

readonly count: number;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém os itens filhos carregados nesta coleção.

readonly items: OneNote.Page[];

Valor da propriedade

Obtém a coleção de páginas com o título especificado.

getByTitle(title: string): OneNote.PageCollection;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

await OneNote.run(async (context) => {

    // Get all the pages in the current section.
    const allPages = context.application.getActiveSection().pages;

    // Queue a command to load the pages.
    // For best performance, request specific properties.
    allPages.load("id"); 

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Get the sections with the specified name.
    const todoPages = allPages.getByTitle("Todo list");

    // Queue a command to load the section.
    // For best performance, request specific properties.
    todoPages.load("id,title"); 

    await context.sync()

    // Iterate through the collection or access items individually by index.
    if (todoPages.items.length > 0) {
        console.log("Page title: " + todoPages.items[0].title);
        console.log("Page ID: " + todoPages.items[0].id);
    }
});

Obtém uma página pela ID ou pelo índice na coleção. Somente leitura.

getItem(index: number | string): OneNote.Page;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém uma página na posição dela na coleção.

getItemAt(index: number): OneNote.Page;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: OneNote.Interfaces.PageCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.PageCollection;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): OneNote.PageCollection;

Parâmetros

Retornos

Exemplos

await OneNote.run(async (context) => {
    
    // Get the pages in the current section.
    const pages = context.application.getActiveSection().pages;
    
    // Queue a command to load the id and title for each page.
    pages.load('id,title');
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Display the properties.
    $.each(pages.items, function(index, page) {
        console.log(page.title);
        console.log(page.id);
    });
});

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.PageCollection;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original OneNote.PageCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.PageCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): OneNote.Interfaces.PageCollectionData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.

track(): OneNote.PageCollection;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): OneNote.PageCollection;

Retornos