Share via

OneNote.Application class

  • Referencia
Paquete:
onenote

Representa el objeto de nivel superior que contiene todos los objetos de OneNote a los que se pueden hacer referencia globalmente, como blocs de notas, el bloc de notas activo y la sección activa.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
notebooks

Obtiene la colección de blocs de notas que están abiertos en la instancia de la aplicación de OneNote. En OneNote Online, solo se abre un bloc de notas en la instancia de la aplicación. Solo lectura.

Métodos

getActiveNotebook()

Obtiene el bloc de notas activo si existe alguno. Si no hay ningún bloc de notas activo, lanza ItemNotFound.
getActiveNotebookOrNull()

Obtiene el bloc de notas activo si existe alguno. Si no hay ningún bloc de notas activo, devuelve NULL.
getActiveOutline()

Obtiene el esquema activo si existe alguno. Si no hay ninguno, lanza ItemNotFound.
getActiveOutlineOrNull()

Obtiene el esquema activo si existe. De lo contrario, devuelve NULL.
getActivePage()

Obtiene la página activa si existe alguna. Si no hay ninguna página activa, lanza ItemNotFound.
getActivePageOrNull()

Obtiene la página activa si existe alguna. Si no hay ninguna página activa, devuelve NULL.
getActiveParagraph()

Obtiene el párrafo activo si existe, si no hay ningún párrafo activo, produce ItemNotFound.
getActiveParagraphOrNull()

Obtiene el párrafo activo si existe uno; de lo contrario, devuelve null.
getActiveSection()

Obtiene la sección activa si existe alguna. Si no hay ninguna sección activa, lanza ItemNotFound.
getActiveSectionOrNull()

Obtiene la sección activa si existe alguna. Si no hay ninguna sección activa, devuelve NULL.
getSelectedInkStrokes()

Obtiene los trazos de lápiz seleccionados actualmente.
getWindowSize()
insertHtmlAtCurrentPosition(html)
isViewingDeletedNotes()
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
navigateToPage(page)

Abre la página especificada en la instancia de la aplicación.
navigateToPageWithClientUrl(url)

Obtiene la página especificada y la abre en la instancia de la aplicación. Es posible que la navegación todavía no se realice cuando no se produzca ningún error. El autor de la llamada debe validar la página devuelta si así lo desea.
set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto OneNote.Application original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.ApplicationData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

OneNote.RequestContext

notebooks

Obtiene la colección de blocs de notas que están abiertos en la instancia de la aplicación de OneNote. En OneNote Online, solo se abre un bloc de notas en la instancia de la aplicación. Solo lectura.

readonly notebooks: OneNote.NotebookCollection;

Valor de propiedad

OneNote.NotebookCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

getActiveNotebook()

Obtiene el bloc de notas activo si existe alguno. Si no hay ningún bloc de notas activo, lanza ItemNotFound.

getActiveNotebook(): OneNote.Notebook;

Devoluciones

OneNote.Notebook

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getActiveNotebookOrNull()

Obtiene el bloc de notas activo si existe alguno. Si no hay ningún bloc de notas activo, devuelve NULL.

getActiveNotebookOrNull(): OneNote.Notebook;

Devoluciones

OneNote.Notebook

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getActiveOutline()

Obtiene el esquema activo si existe alguno. Si no hay ninguno, lanza ItemNotFound.

getActiveOutline(): OneNote.Outline;

Devoluciones

OneNote.Outline

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getActiveOutlineOrNull()

Obtiene el esquema activo si existe. De lo contrario, devuelve NULL.

getActiveOutlineOrNull(): OneNote.Outline;

Devoluciones

OneNote.Outline

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getActivePage()

Obtiene la página activa si existe alguna. Si no hay ninguna página activa, lanza ItemNotFound.

getActivePage(): OneNote.Page;

Devoluciones

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getActivePageOrNull()

Obtiene la página activa si existe alguna. Si no hay ninguna página activa, devuelve NULL.

getActivePageOrNull(): OneNote.Page;

Devoluciones

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getActiveParagraph()

Obtiene el párrafo activo si existe, si no hay ningún párrafo activo, produce ItemNotFound.

getActiveParagraph(): OneNote.Paragraph;

Devoluciones

OneNote.Paragraph

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

getActiveParagraphOrNull()

Obtiene el párrafo activo si existe uno; de lo contrario, devuelve null.

getActiveParagraphOrNull(): OneNote.Paragraph;

Devoluciones

OneNote.Paragraph

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

getActiveSection()

Obtiene la sección activa si existe alguna. Si no hay ninguna sección activa, lanza ItemNotFound.

getActiveSection(): OneNote.Section;

Devoluciones

OneNote.Section

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getActiveSectionOrNull()

Obtiene la sección activa si existe alguna. Si no hay ninguna sección activa, devuelve NULL.

getActiveSectionOrNull(): OneNote.Section;

Devoluciones

OneNote.Section

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

getSelectedInkStrokes()

Obtiene los trazos de lápiz seleccionados actualmente.

getSelectedInkStrokes(): OneNote.InkStrokeCollection;

Devoluciones

OneNote.InkStrokeCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.9 ]

getWindowSize() 

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

Devoluciones

OfficeExtension.ClientResult<number[]>

insertHtmlAtCurrentPosition(html) 

insertHtmlAtCurrentPosition(html: string): void;

Parámetros

html

string

Devoluciones

void

isViewingDeletedNotes() 

isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;

Devoluciones

OfficeExtension.ClientResult<boolean>

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: OneNote.Interfaces.ApplicationLoadOptions): OneNote.Application;

Parámetros

options
OneNote.Interfaces.ApplicationLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

OneNote.Application

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

OneNote.Application

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

OneNote.Application

navigateToPage(page)

Abre la página especificada en la instancia de la aplicación.

navigateToPage(page: OneNote.Page): void;

Parámetros

page
OneNote.Page

La página que se abrirá.

Devoluciones

void

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

navigateToPageWithClientUrl(url)

Obtiene la página especificada y la abre en la instancia de la aplicación. Es posible que la navegación todavía no se realice cuando no se produzca ningún error. El autor de la llamada debe validar la página devuelta si así lo desea.

navigateToPageWithClientUrl(url: string): OneNote.Page;

Parámetros

url

string

La URL del cliente de la página que se abrirá.

Devoluciones

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

properties
OneNote.Interfaces.ApplicationUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: OneNote.Application): void;

Parámetros

properties
OneNote.Application

Devoluciones

void

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto OneNote.Application original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.ApplicationData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): OneNote.Interfaces.ApplicationData;

Devoluciones

OneNote.Interfaces.ApplicationData