OneNote.SectionCollection class
Representa una colección de secciones.
- Extends
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. |
| count | Devuelve el número de secciones de una colección. Solo lectura. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| get |
Obtiene la colección de secciones con el nombre especificado. |
| get |
Obtiene una sección por su identificador o por su índice en la colección. Solo lectura. |
| get |
Obtiene una sección 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 |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Invalida el método JavaScript |
| track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para |
| untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para |
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
count
Devuelve el número de secciones de una colección. Solo lectura.
readonly count: number;Valor de propiedad
number
Comentarios
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: OneNote.Section[];Valor de propiedad
Detalles del método
getByName(name)
Obtiene la colección de secciones con el nombre especificado.
getByName(name: string): OneNote.SectionCollection;Parámetros
- name
-
string
El nombre de la sección.
Devoluciones
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Ejemplos
await OneNote.run(async (context) => {
// Get the sections in the current notebook.
const sections = context.application.getActiveNotebook().sections;
// Queue a command to load the sections.
// For best performance, request specific properties.
sections.load("id");
// Get the sections with the specified name.
const groceriesSections = sections.getByName("Groceries");
// Queue a command to load the sections with the specified name.
groceriesSections.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.
if (groceriesSections.items.length > 0) {
console.log("Section name: " + groceriesSections.items[0].name);
console.log("Section ID: " + groceriesSections.items[0].id);
}
});
getItem(index)
Obtiene una sección por su identificador o por su índice en la colección. Solo lectura.
getItem(index: number | string): OneNote.Section;Parámetros
- index
-
number | string
El id. de la sección, o bien la ubicación del índice de la sección en la colección.
Devoluciones
Comentarios
getItemAt(index)
Obtiene una sección según su posición en la colección.
getItemAt(index: number): OneNote.Section;Parámetros
- index
-
number
Valor de índice del objeto que se va a recuperar. Indizado con cero.
Devoluciones
Comentarios
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.SectionCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.SectionCollection;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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.SectionCollection;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
Ejemplos
await OneNote.run(async (context) => {
// Get the sections in the current notebook.
const sections = context.application.getActiveNotebook().sections;
// Queue a command to load the sections.
// For best performance, request specific properties.
sections.load("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: sections.items[0]
$.each(sections.items, function(index, section) {
if (section.name === "Homework") {
section.addPage("Biology");
section.addPage("Spanish");
section.addPage("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.SectionCollection;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
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.SectionCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.SectionCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): OneNote.Interfaces.SectionCollectionData;Devoluciones
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.SectionCollection;Devoluciones
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.SectionCollection;