OneNote.NotebookCollection class

Referencia

Paquete:: onenote

Representa una colección de blocs de notas.

Extends: OfficeExtension.ClientObject

Comentarios

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
count	Devuelve el número de blocs de notas de una colección. Solo lectura.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

getByName(name)	Obtiene la colección de blocs de notas con el nombre especificado que están abiertos en la instancia de la aplicación.
getItem(index)	Obtiene un bloc de notas por ID o por su índice en la colección. Solo lectura.
getItemAt(index)	Obtiene un bloc de notas según su posición en la colección.
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.
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.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto original `OneNote.NotebookCollection` es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `OneNote.Interfaces.NotebookCollectionData`) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.
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 recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe haber agregado 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

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

count

Devuelve el número de blocs de notas de una colección. Solo lectura.

readonly count: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: OneNote.Notebook[];

Valor de propiedad

OneNote.Notebook[]

Detalles del método

getByName(name)

Obtiene la colección de blocs de notas con el nombre especificado que están abiertos en la instancia de la aplicación.

getByName(name: string): OneNote.NotebookCollection;

Parámetros

name: string

El nombre del bloc de notas.

Devoluciones

OneNote.NotebookCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

    // Get the notebooks that are open in the application instance and have the specified name.
    const notebooks = context.application.notebooks.getByName("Homework");

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

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

    // Iterate through the collection or access items individually by index.
    // For example: notebooks.items[0]
    if (notebooks.items.length > 0) {
        console.log("Notebook name: " + notebooks.items[0].name);
        console.log("Notebook ID: " + notebooks.items[0].id);
    }
});

getItem(index)

Obtiene un bloc de notas por ID o por su índice en la colección. Solo lectura.

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

Parámetros

index: number | string

El id. del bloc de notas, o bien la ubicación del índice del bloc de notas en la colección.

Devoluciones

OneNote.Notebook

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

getItemAt(index)

Obtiene un bloc de notas según su posición en la colección.

getItemAt(index: number): OneNote.Notebook;

Parámetros

index: number

Valor de índice del objeto que se va a recuperar. Indizado con cero.

Devoluciones

OneNote.Notebook

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

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

Parámetros

options: OneNote.Interfaces.NotebookCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions

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

Devoluciones

OneNote.NotebookCollection

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

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

Ejemplos

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

    // Get the notebooks that are open in the application instance and have the specified name.
    const notebooks = context.application.notebooks.getByName("Homework");

    // Queue a command to load the notebooks.
    // For best performance, request specific properties.
    notebooks.load("id");

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

    // Iterate through the collection or access items individually by index.
    // For example: notebooks.items[0]
    $.each(notebooks.items, function(index, notebook) {
        notebook.addSection("Biology");
        notebook.addSection("Spanish");
        notebook.addSection("Computer Science");
    });
    
    await context.sync();
});

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?: OfficeExtension.LoadOption): OneNote.NotebookCollection;

Parámetros

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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.NotebookCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.NotebookCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): OneNote.Interfaces.NotebookCollectionData;

Devoluciones

OneNote.Interfaces.NotebookCollectionData

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 recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe haber agregado el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.

track(): OneNote.NotebookCollection;

Devoluciones

OneNote.NotebookCollection

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

Devoluciones

OneNote.NotebookCollection

Share via

OneNote.NotebookCollection class

Comentarios

Propiedades

Métodos

Detalles de las propiedades

context

Valor de propiedad

count

Valor de propiedad

Comentarios

items

Valor de propiedad

Detalles del método

getByName(name)

Parámetros

Devoluciones

Comentarios

Ejemplos

getItem(index)

Parámetros

Devoluciones

Comentarios

getItemAt(index)

Parámetros

Devoluciones

Comentarios

load(options)

Parámetros

Devoluciones

load(propertyNames)

Parámetros

Devoluciones

Ejemplos

load(propertyNamesAndPaths)

Parámetros

Devoluciones

toJSON()

Devoluciones

track()

Devoluciones

untrack()

Devoluciones

Comentarios

Recursos adicionales