OneNote.Application 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

Obtém a coleção de blocos de notas abertos na instância do aplicativo OneNote. No OneNote Online, apenas um bloco de anotações de cada vez é aberto na instância do aplicativo. Somente leitura.

readonly notebooks: OneNote.NotebookCollection;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o bloco de anotações ativo, se houver um. Se não houver nenhum bloco de anotações ativo, gera ItemNotFound.

getActiveNotebook(): OneNote.Notebook;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

await OneNote.run(async (context) => {
        
    // Get the active notebook.
    const notebook = context.application.getActiveNotebook();
            
    // Queue a command to load the notebook.
    // For best performance, request specific properties.
    notebook.load('id,name');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
                    
    // Show some properties.
    console.log("Notebook name: " + notebook.name);
    console.log("Notebook ID: " + notebook.id);
            
});

Obtém o bloco de anotações ativo, se houver um. Se não houver nenhum bloco de anotações ativo, retorna nulo.

getActiveNotebookOrNull(): OneNote.Notebook;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

    // Get the active notebook.
    const notebook = context.application.getActiveNotebookOrNull();

    // Queue a command to load the notebook.
    // For best performance, request specific properties.
    notebook.load('id,name');

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

    // Check if active notebook is set.
    if (!notebook.isNullObject) {
        console.log("Notebook name: " + notebook.name);
        console.log("Notebook ID: " + notebook.id);
    }
});

Obtém a estrutura de tópicos ativa, se houver uma. Caso contrário, gera ItemNotFound.

getActiveOutline(): OneNote.Outline;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

    // get active outline.
    const outline = context.application.getActiveOutline();

    // Queue a command to load the id of the outline.
    outline.load('id');

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

    // Show some properties.
    console.log("outline id: " + outline.id);
});

Obtém a estrutura de tópicos ativa, se houver uma; caso contrário, retorna nulo.

getActiveOutlineOrNull(): OneNote.Outline;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

    // get active outline.
    const outline = context.application.getActiveOutlineOrNull();

    // Queue a command to load the id of the outline.
    outline.load('id');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (!outline.isNullObject) {
        console.log("outline id: " + outline.id);
    }
});

Obtém a página ativa, se houver uma. Se não houver nenhuma página ativa, gera ItemNotFound.

getActivePage(): OneNote.Page;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

await OneNote.run(async (context) => {
        
    // Get the active page.
    const page = context.application.getActivePage();
            
    // Queue a command to load the page.
    // For best performance, request specific properties.
    page.load('id,title');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
                    
    // Show some properties.
    console.log("Page title: " + page.title);
    console.log("Page ID: " + page.id);
});

Obtém a página ativa, se houver uma. Se não houver nenhuma página ativa, retorna nulo.

getActivePageOrNull(): OneNote.Page;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

    // Get the active page.
    const page = context.application.getActivePageOrNull();

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

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    if (!page.isNullObject) {
        // Show some properties.
        console.log("Page title: " + page.title);
        console.log("Page ID: " + page.id);
    }
});

Obtém o Parágrafo ativo se existir um, se nenhum Parágrafo estiver ativo, será apresentado ItemNotFound.

getActiveParagraph(): OneNote.Paragraph;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o Parágrafo ativo se existir, caso contrário, devolve nulo.

getActiveParagraphOrNull(): OneNote.Paragraph;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém a seção ativa, se houver uma. Se não houver nenhuma seção ativa, gera ItemNotFound.

getActiveSection(): OneNote.Section;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

await OneNote.run(async (context) => {
        
    // Get the active section.
    const section = context.application.getActiveSection();
            
    // Queue a command to load the section.
    // For best performance, request specific properties.
    section.load('id,name');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
                    
    // Show some properties.
    console.log("Section name: " + section.name);
    console.log("Section ID: " + section.id);
});

Obtém a seção ativa, se houver uma. Se não houver nenhuma seção ativa, retorna nulo.

getActiveSectionOrNull(): OneNote.Section;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

    // Get the active section.
    const section = context.application.getActiveSectionOrNull();

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

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (!section.isNullObject) {
        // Show some properties.
        console.log("Section name: " + section.name);
        console.log("Section ID: " + section.id);
    }
});

getDecimalSeparator(): OfficeExtension.ClientResult<string>;

Retornos

Obtém os traços de tinta digital selecionados atualmente.

getSelectedInkStrokes(): OneNote.InkStrokeCollection;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.9 ]

getWindowSize(): OfficeExtension.ClientResult<number[]>;

Retornos

insertAndEmbedLinkAtCurrentPosition(url: string): void;

Parâmetros

Retornos

insertHtmlAtCurrentPosition(html: string): void;

Parâmetros

Retornos

isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;

Retornos

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.ApplicationLoadOptions): OneNote.Application;

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

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(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.Application;

Parâmetros

Retornos

Abre a página especificada na instância do aplicativo.

navigateToPage(page: OneNote.Page): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

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 pages.
    // For best performance, request specific properties.
    pages.load('id');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync()
                    
    // This example loads the first page in the section.
    const page = pages.items[0];
                
    // Open the page in the application.
    context.application.navigateToPage(page);
            
    // Run the queued command.
    await context.sync();
});

Obtém a página especificada e a abre na instância do aplicativo. A navegação pode ainda não ser efetuada quando não há falhas. O autor da chamada deve validar a página devolvida, se assim o desejar.

navigateToPageWithClientUrl(url: string): OneNote.Page;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

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 pages.
    // For best performance, request specific properties.
    pages.load('clientUrl');

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

    // This example loads the first page in the section.
    const page = pages.items[0];

    // Open the page in the application.
    context.application.navigateToPageWithClientUrl(page.clientUrl);

    // Run the queued command.
    await context.sync();
});

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

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

set(properties: OneNote.Application): void;

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.Application é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): OneNote.Interfaces.ApplicationData;

Retornos