Compartir a través de

OneNote.Page class

  • Referencia
Paquete:
onenote

Representa una página de OneNote.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

classNotebookPageSource

Obtiene classNotebookPageSource a la página.
clientUrl

La URL del cliente de la página.
contents

Obtiene la colección de objetos PageContent de la página. Solo lectura
context

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

Obtiene el identificador de la página.
inkAnalysisOrNull

Interpretación del texto para la tinta de la página. Devuelve NULL si no hay ninguna información de análisis de tinta.
pageLevel

Obtiene o establece el nivel de sangría de la página.
parentSection

Obtiene la sección que contiene la página.
title

Obtiene o establece el título de la página.
webUrl

La URL de la web de la página.

Métodos

addOutline(left, top, html)

Agrega un Outline a la página en la posición especificada.
analyzePage()

Devuelve una cadena JSON con el identificador de nodo y el contenido en formato HTML.
applyTranslation(translatedContent)

Inserta una página nueva con contenido traducido.
copyToSection(destinationSection)

Copia esta página en la sección especificada.
copyToSectionAndSetClassNotebookPageSource(destinationSection)

Copia esta página en la sección especificada y establece ClassNotebookPageSource.
getRestApiId()

Obtiene el identificador de la API REST.
hasTitleContent()

¿La página tiene el título de contenido?
insertPageAsSibling(location, title)

Inserta una nueva página antes o después de la página actual.
insertPageAsSibling(locationString, title)

Inserta una nueva página antes o después de la página actual.
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.
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 original OneNote.Page es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.PageData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.
untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

classNotebookPageSource

Obtiene classNotebookPageSource a la página.

readonly classNotebookPageSource: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

clientUrl

La URL del cliente de la página.

readonly clientUrl: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

contents

Obtiene la colección de objetos PageContent de la página. Solo lectura

readonly contents: OneNote.PageContentCollection;

Valor de propiedad

OneNote.PageContentCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

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

id

Obtiene el identificador de la página.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

inkAnalysisOrNull

Interpretación del texto para la tinta de la página. Devuelve NULL si no hay ninguna información de análisis de tinta.

readonly inkAnalysisOrNull: OneNote.InkAnalysis;

Valor de propiedad

OneNote.InkAnalysis

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

pageLevel

Obtiene o establece el nivel de sangría de la página.

pageLevel: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

parentSection

Obtiene la sección que contiene la página.

readonly parentSection: OneNote.Section;

Valor de propiedad

OneNote.Section

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

title

Obtiene o establece el título de la página.

title: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

webUrl

La URL de la web de la página.

readonly webUrl: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

addOutline(left, top, html)

Agrega un Outline a la página en la posición especificada.

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

Parámetros

left

number

La posición izquierda de la esquina superior izquierda del Outline.

top

number

La posición superior de la esquina superior izquierda del Outline.

html

string

Una cadena HTML que describe la presentación visual del Outline. Consulte HTML compatible para la API de JavaScript de complementos de OneNote.

Devoluciones

OneNote.Outline

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

analyzePage()

Devuelve una cadena JSON con el identificador de nodo y el contenido en formato HTML.

analyzePage(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

applyTranslation(translatedContent)

Inserta una página nueva con contenido traducido.

applyTranslation(translatedContent: string): void;

Parámetros

translatedContent

string

Contenido traducido de la página.

Devoluciones

void

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

copyToSection(destinationSection)

Copia esta página en la sección especificada.

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

Parámetros

destinationSection
OneNote.Section

La sección en la que hay que copiar esta página.

Devoluciones

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

copyToSectionAndSetClassNotebookPageSource(destinationSection)

Copia esta página en la sección especificada y establece ClassNotebookPageSource.

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

Parámetros

destinationSection
OneNote.Section

Devoluciones

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

getRestApiId()

Obtiene el identificador de la API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

hasTitleContent()

¿La página tiene el título de contenido?

hasTitleContent(): OfficeExtension.ClientResult<boolean>;

Devoluciones

OfficeExtension.ClientResult<boolean>

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

insertPageAsSibling(location, title)

Inserta una nueva página antes o después de la página actual.

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

Parámetros

location
OneNote.InsertLocation

La ubicación de la nueva página relativa a la página actual.

title

string

El título de la nueva página.

Devoluciones

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

insertPageAsSibling(locationString, title)

Inserta una nueva página antes o después de la página actual.

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

Parámetros

locationString

"Before" | "After"

La ubicación de la nueva página relativa a la página actual.

title

string

El título de la nueva página.

Devoluciones

OneNote.Page

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

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

Parámetros

options
OneNote.Interfaces.PageLoadOptions

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

Devoluciones

OneNote.Page

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

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

Ejemplos

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

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

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

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.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
OneNote.Interfaces.PageUpdateData

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

Parámetros

properties
OneNote.Page

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 original OneNote.Page es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.PageData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): OneNote.Interfaces.PageData;

Devoluciones

OneNote.Interfaces.PageData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.

track(): OneNote.Page;

Devoluciones

OneNote.Page

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): OneNote.Page;

Devoluciones

OneNote.Page