OneNote.Section class
Representa una sección de OneNote. Las secciones pueden contener páginas.
- Extends
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Propiedades
| client |
URL del cliente de la sección. 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 sección. Solo lectura. |
| is |
True si esta sección se cifra con una contraseña. Solo lectura |
| is |
True si esta sección está bloqueada. Solo lectura |
| name | Obtiene el nombre de la sección. Solo lectura. |
| notebook | Obtiene el bloc de notas que contiene la página. Solo lectura. |
| pages | Colección de páginas de la sección. Solo lectura |
| parent |
Obtiene el grupo de secciones que contiene la sección. Genera ItemNotFound si la sección es un elemento secundario directo del bloc de notas. Solo lectura. |
| parent |
Obtiene el grupo de secciones que contiene la sección. Devuelve nulo si la sección no es un elemento secundario directo del bloc de notas. Solo lectura. |
| web |
La URL de la web de la página. Solo lectura |
Métodos
| add |
Agrega una nueva página al final de la sección. |
| copy |
Copia esta sección en el Bloc de notas especificado. |
| copy |
Copia esta sección en el grupo de secciones especificado. |
| get |
Obtiene el identificador de la API REST. |
| insert |
Inserta una nueva sección antes o después de la sección actual. |
| insert |
Inserta una nueva sección antes o después de la sección actual. |
| 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
clientUrl
URL del cliente de la sección. 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 de la sección. Solo lectura.
readonly id: string;Valor de propiedad
string
Comentarios
isEncrypted
True si esta sección se cifra con una contraseña. Solo lectura
readonly isEncrypted: boolean;Valor de propiedad
boolean
Comentarios
isLocked
True si esta sección está bloqueada. Solo lectura
readonly isLocked: boolean;Valor de propiedad
boolean
Comentarios
name
Obtiene el nombre de la sección. Solo lectura.
readonly name: string;Valor de propiedad
string
Comentarios
notebook
Obtiene el bloc de notas que contiene la página. Solo lectura.
readonly notebook: OneNote.Notebook;Valor de propiedad
Comentarios
pages
Colección de páginas de la sección. Solo lectura
readonly pages: OneNote.PageCollection;Valor de propiedad
Comentarios
parentSectionGroup
Obtiene el grupo de secciones que contiene la sección. Genera ItemNotFound si la sección es un elemento secundario directo del bloc de notas. Solo lectura.
readonly parentSectionGroup: OneNote.SectionGroup;Valor de propiedad
Comentarios
parentSectionGroupOrNull
Obtiene el grupo de secciones que contiene la sección. Devuelve nulo si la sección no es un elemento secundario directo del bloc de notas. Solo lectura.
readonly parentSectionGroupOrNull: OneNote.SectionGroup;Valor de propiedad
Comentarios
webUrl
La URL de la web de la página. Solo lectura
readonly webUrl: string;Valor de propiedad
string
Comentarios
Detalles del método
addPage(title)
Agrega una nueva página al final de la sección.
addPage(title: string): OneNote.Page;Parámetros
- title
-
string
El título de la nueva página.
Devoluciones
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Ejemplos
await OneNote.run(async (context) => {
// Queue a command to add a page to the current section.
const page = context.application.getActiveSection().addPage("Wish list");
// Queue a command to load the id and title of the new page.
// This example loads the new page so it can read its properties later.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Page name: " + page.title);
console.log("Page ID: " + page.id);
});
copyToNotebook(destinationNotebook)
Copia esta sección en el Bloc de notas especificado.
copyToNotebook(destinationNotebook: OneNote.Notebook): OneNote.Section;Parámetros
- destinationNotebook
- OneNote.Notebook
El bloc de notas en el que hay que copiar esta sección.
Devoluciones
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 Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
newSection = section.copyToNotebook(notebook);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
copyToSectionGroup(destinationSectionGroup)
Copia esta sección en el grupo de secciones especificado.
copyToSectionGroup(destinationSectionGroup: OneNote.SectionGroup): OneNote.Section;Parámetros
- destinationSectionGroup
- OneNote.SectionGroup
El grupo de secciones en el que hay que copiar esta sección.
Devoluciones
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 Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
const firstSectionGroup = notebook.sectionGroups.items[0];
newSection = section.copyToSectionGroup(firstSectionGroup);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
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 section.
const section = context.application.getActiveSection();
const restApiId = section.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
});
insertSectionAsSibling(location, title)
Inserta una nueva sección antes o después de la sección actual.
insertSectionAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Section;Parámetros
- location
- OneNote.InsertLocation
La ubicación de la nueva sección relativa a la sección actual.
- title
-
string
Nombre de la nueva sección.
Devoluciones
Comentarios
insertSectionAsSibling(locationString, title)
Inserta una nueva sección antes o después de la sección actual.
insertSectionAsSibling(locationString: "Before" | "After", title: string): OneNote.Section;Parámetros
- locationString
-
"Before" | "After"
La ubicación de la nueva sección relativa a la sección actual.
- title
-
string
Nombre de la nueva sección.
Devoluciones
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Ejemplos
await OneNote.run(async (context) => {
// Queue a command to insert a section after the current section.
const section = context.application.getActiveSection().insertSectionAsSibling("After", "New section");
// Queue a command to load the id and name of the new section.
// This example loads the new section so it can read its properties later.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
});
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.SectionLoadOptions): OneNote.Section;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.Section;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 section.
const section = context.application.getActiveSection();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load("id");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("Section ID: " + section.id);
});
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.Section;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 OneNote.Section original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.SectionData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): OneNote.Interfaces.SectionData;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.Section;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.Section;Devoluciones
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de