OneNote.Page class

Obtém o ClassNotebookPageSource para a página.

readonly classNotebookPageSource: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

A URL do cliente da página.

readonly clientUrl: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém o conjunto de objetos PageContent na página. Somente leitura

readonly contents: OneNote.PageContentCollection;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Obtém o ID da página.

readonly id: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Interpretação de texto para a tinta na página. Retorna null se não houver informação de análise de tinta.

readonly inkAnalysisOrNull: OneNote.InkAnalysis;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém ou define o nível de recuo da página.

pageLevel: number;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Retorna a seção que contém a página.

readonly parentSection: OneNote.Section;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém ou define o título da página.

title: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

A URL da Web da página.

readonly webUrl: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Adiciona uma estrutura de página em uma posição especificada.

addOutline(left: number, top: number, html: string): OneNote.Outline;

Parâmetros

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Exemplos

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

    // Gets the active page.
    const page = context.application.getActivePage();

    // Queue a command to add an outline with given html.
    const outline = page.addOutline(200, 200,
"<p>Images and a table below:</p> \
 <img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\"> \
 <img src=\"http://imagenes.es.sftcdn.net/es/scrn/6653000/6653659/microsoft-onenote-2013-01-535x535.png\"> \
 <table> \
   <tr> \
     <td>Jill</td> \
     <td>Smith</td> \
     <td>50</td> \
   </tr> \
   <tr> \
     <td>Eve</td> \
     <td>Jackson</td> \
     <td>94</td> \
   </tr> \
 </table>"     
        );

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

Retorna uma cadeia de caracteres JSON com ID de nó e conteúdo no formato HTML.

analyzePage(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Insere uma nova página com conteúdo traduzido.

applyTranslation(translatedContent: string): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Copia esta página para a seção especificada.

copyToSection(destinationSection: OneNote.Section): OneNote.Page;

Parâmetros

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Exemplos

await OneNote.run(async (context) => {
    const app = context.application;
    
    // Gets the active notebook.
    const notebook = app.getActiveNotebook();
    
    // Gets the active page.
    const page = app.getActivePage();
    
    // Queue a command to load sections under the notebook.
    notebook.load('sections');
    
    let newPage;
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const section = notebook.sections.items[0];
    
    // Copy page to the section.
    newPage = page.copyToSection(section);
    newPage.load('id');
    await context.sync();
    
    console.log(newPage.id);
});

Copia esta página para a seção especificada e define ClassNotebookPageSource.

copyToSectionAndSetClassNotebookPageSource(destinationSection: OneNote.Section): OneNote.Page;

Parâmetros

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém a ID da API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Exemplos

await OneNote.run(async (context) => {
    // Get the current page.
    const page = context.application.getActivePage();
    const restApiId = page.getRestApiId();

    await context.sync();
    console.log("The REST API ID is " + restApiId.value);
    // Note that the REST API ID isn't all you need to interact with the OneNote REST API.
    // This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
    // For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
    // according to the OneNote Development Blog.
    // https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});

A página tem título de conteúdo.

hasTitleContent(): OfficeExtension.ClientResult<boolean>;

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Insere uma nova página antes ou depois da página atual.

insertPageAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Page;

Parâmetros

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Insere uma nova página antes ou depois da página atual.

insertPageAsSibling(location: "Before" | "After", title: string): OneNote.Page;

Parâmetros

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Exemplos

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const newPage = activePage.insertPageAsSibling("After", "Next Page");

    // Queue a command to load the newPage to access its data.
    context.load(newPage);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("page is created with title: " + newPage.title);
});

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.PageLoadOptions): OneNote.Page;

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

Parâmetros

Retornos

Exemplos

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync()
    for(let i=0; i < pageContents.items.length; i++) {
        const pageContent = pageContents.items[i];
        if (pageContent.type == "Outline") {
            console.log("Found an outline");
        } else if (pageContent.type == "Image") {
            console.log("Found an image");
        } else if (pageContent.type == "Other") {
            console.log("Found a type not supported yet.");
        }
    }
});

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.Page;

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: OneNote.Page): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original OneNote.Page é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como OneNote.Interfaces.PageData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): OneNote.Interfaces.PageData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse 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, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez.

track(): OneNote.Page;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): OneNote.Page;

Retornos