OneNote.PageContentCollection 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 a quantidade de conteúdo da página no conjunto.

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.PageContent[];

Valor da propriedade

Obtém um objeto PageContent pela ID ou pelo índice na coleção. Somente leitura.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém um conteúdo de página na posição dela na coleção.

getItemAt(index: number): OneNote.PageContent;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

    const page = context.application.getActivePage();
    const pageContents = page.contents;
    const firstPageContent = pageContents.getItemAt(0);
    firstPageContent.load('type');

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

    console.log("The first page content item is of type: " + firstPageContent.type);
    await context.sync();
});

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.PageContentCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.PageContentCollection;

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.PageContentCollection;

Parâmetros

Retornos

Exemplos

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Queue a command to load the type of each pageContent.
    pageContents.load("type");

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

    $.each(pageContents.items, function(index, pageContent) {
        console.log("PageContent type: " + pageContent.type);
    });
});

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.PageContentCollection;

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.PageContentCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.PageContentCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): OneNote.Interfaces.PageContentCollectionData;

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.PageContentCollection;

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.PageContentCollection;

Retornos