OneNote.Notebook class
Representa un bloc de notas de OneNote. Los blocs de notas contienen grupos de secciones y secciones.
- Extends
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Propiedades
| base |
Dirección URL del sitio donde se encuentra este cuaderno. Solo lectura. |
| client |
La URL del cliente del bloc de notas. 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 del bloc de notas. Solo lectura. |
| is |
True si el usuario no crea el cuaderno (es decir, "Secciones mal colocadas"). |
| name | Obtiene el nombre del bloc de notas. |
| section |
Los grupos de secciones del bloc de notas. |
| sections | Secciones del bloc de notas. |
Métodos
| add |
Agrega una nueva sección al final del bloc de notas. |
| add |
Agrega un nuevo grupo de secciones al final del bloc de notas. |
| get |
Obtiene el identificador de la API REST. |
| 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 context.trackedObjects.add(thisObject). Si usa este objeto entre |
| 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 |
Detalles de las propiedades
baseUrl
Dirección URL del sitio donde se encuentra este cuaderno. Solo lectura.
readonly baseUrl: string;Valor de propiedad
string
Comentarios
clientUrl
La URL del cliente del bloc de notas. Solo lectura.
readonly clientUrl: string;Valor de propiedad
string
Comentarios
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
id
Obtiene el identificador del bloc de notas. Solo lectura.
readonly id: string;Valor de propiedad
string
Comentarios
isVirtual
True si el usuario no crea el cuaderno (es decir, "Secciones mal colocadas").
readonly isVirtual: boolean;Valor de propiedad
boolean
Comentarios
name
Obtiene el nombre del bloc de notas.
readonly name: string;Valor de propiedad
string
Comentarios
sectionGroups
Los grupos de secciones del bloc de notas.
readonly sectionGroups: OneNote.SectionGroupCollection;Valor de propiedad
Comentarios
sections
Secciones del bloc de notas.
readonly sections: OneNote.SectionCollection;Valor de propiedad
Comentarios
Detalles del método
addSection(name)
Agrega una nueva sección al final del bloc de notas.
addSection(name: string): OneNote.Section;Parámetros
- name
-
string
Nombre de la nueva sección.
Devoluciones
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Ejemplos
await OneNote.run(async (context) => {
// Gets the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to add a new section.
const section = notebook.addSection("Sample section");
// Queue a command to load the new section. This example reads the name property later.
section.load("name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("New section name is " + section.name);
});
addSectionGroup(name)
Agrega un nuevo grupo de secciones al final del bloc de notas.
addSectionGroup(name: string): OneNote.SectionGroup;Parámetros
- name
-
string
Nombre de la nueva sección.
Devoluciones
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Ejemplos
await OneNote.run(async (context) => {
// Gets the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to add a new section group.
const sectionGroup = notebook.addSectionGroup("Sample section group");
// Queue a command to load the new section group.
sectionGroup.load();
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("New section group name is " + sectionGroup.name);
});
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 notebook.
const notebook = context.application.getActiveNotebook();
const restApiId = notebook.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
});
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.NotebookLoadOptions): OneNote.Notebook;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.Notebook;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 current notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to load the notebook.
// For best performance, request specific properties.
notebook.load('baseUrl');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("Base url: " + notebook.baseUrl);
// This is only required for SharePoint notebooks, and will be null for OneDrive notebooks.
// This baseUrl should be used to talk to OneNote REST APIs according to the OneNote Development Blog.
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});
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.Notebook;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
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.Notebook es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.NotebookData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): OneNote.Interfaces.NotebookData;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 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.Notebook;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.Notebook;