Share via

OneNote.SectionGroup class

  • Referencia
Paquete:
onenote

Representa un grupo de secciones de OneNote. Los grupos de secciones pueden contener secciones y otros grupos de secciones.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

clientUrl

URL del cliente del grupo de secciones. 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 grupo de secciones. Solo lectura.
name

Obtiene el nombre del grupo de secciones. Solo lectura.
notebook

Obtiene el bloc de notas que contiene el grupo de secciones. Solo lectura.
parentSectionGroup

Obtiene el grupo de secciones que contiene el grupo de secciones. Genera ItemNotFound si el grupo de secciones es un elemento secundario directo del bloc de notas. Solo lectura.
parentSectionGroupOrNull

Obtiene el grupo de secciones que contiene el grupo de secciones. Devuelve nulo si el grupo de secciones no es un elemento secundario directo del bloc de notas. Solo lectura.
sectionGroups

Colección de grupos de secciones en el grupo de secciones. Solo lectura
sections

Colección de secciones en el grupo de secciones. Solo lectura

Métodos

addSection(title)

Agrega una nueva sección al final del grupo de secciones.
addSectionGroup(name)

Agrega un nuevo grupo de secciones al final de este sectionGroup.
getRestApiId()

Obtiene el identificador de la API REST.
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.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto OneNote.SectionGroup original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.SectionGroupData) 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 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

clientUrl

URL del cliente del grupo de secciones. Solo lectura

readonly clientUrl: string;

Valor de propiedad

string

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 del grupo de secciones. Solo lectura.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

name

Obtiene el nombre del grupo de secciones. Solo lectura.

readonly name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

notebook

Obtiene el bloc de notas que contiene el grupo de secciones. Solo lectura.

readonly notebook: OneNote.Notebook;

Valor de propiedad

OneNote.Notebook

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

parentSectionGroup

Obtiene el grupo de secciones que contiene el grupo de secciones. Genera ItemNotFound si el grupo de secciones es un elemento secundario directo del bloc de notas. Solo lectura.

readonly parentSectionGroup: OneNote.SectionGroup;

Valor de propiedad

OneNote.SectionGroup

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

parentSectionGroupOrNull

Obtiene el grupo de secciones que contiene el grupo de secciones. Devuelve nulo si el grupo de secciones no es un elemento secundario directo del bloc de notas. Solo lectura.

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

Valor de propiedad

OneNote.SectionGroup

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

sectionGroups

Colección de grupos de secciones en el grupo de secciones. Solo lectura

readonly sectionGroups: OneNote.SectionGroupCollection;

Valor de propiedad

OneNote.SectionGroupCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

sections

Colección de secciones en el grupo de secciones. Solo lectura

readonly sections: OneNote.SectionCollection;

Valor de propiedad

OneNote.SectionCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

addSection(title)

Agrega una nueva sección al final del grupo de secciones.

addSection(title: string): OneNote.Section;

Parámetros

title

string

Nombre de la nueva sección.

Devoluciones

OneNote.Section

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

    // Get the section groups that are direct children of the current notebook.
    const sectionGroups = context.application.getActiveNotebook().sectionGroups;
    
    // Queue a command to load the section groups.
    // For best performance, request specific properties.
    sectionGroups.load("id");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Add a section to each section group.
    $.each(sectionGroups.items, function(index, sectionGroup) {
        sectionGroup.addSection("Agenda");
    });
    
    // Run the queued commands.
    await context.sync();
});

addSectionGroup(name)

Agrega un nuevo grupo de secciones al final de este sectionGroup.

addSectionGroup(name: string): OneNote.SectionGroup;

Parámetros

name

string

Nombre de la nueva sección.

Devoluciones

OneNote.SectionGroup

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

await OneNote.run(async (context) => {
    let sectionGroup;
    let nestedSectionGroup;

    // Gets the active notebook.
    const notebook = context.application.getActiveNotebook();

    // Queue a command to add a new section group.
    const sectionGroups = notebook.sectionGroups;

    // Queue a command to load the new section group.
    sectionGroups.load();

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

    sectionGroup = sectionGroups.items[0];
    sectionGroup.load();
    await context.sync();

    nestedSectionGroup = sectionGroup.addSectionGroup("Sample nested section group");
    nestedSectionGroup.load();
    await context.sync();
    
    console.log("New nested section group name is " + nestedSectionGroup.name);
});

getRestApiId()

Obtiene el identificador de la API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Devoluciones

OfficeExtension.ClientResult<string>

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.SectionGroupLoadOptions): OneNote.SectionGroup;

Parámetros

options
OneNote.Interfaces.SectionGroupLoadOptions

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

Devoluciones

OneNote.SectionGroup

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

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

Ejemplos

await OneNote.run(async (context) => {
        
    // Get the parent section group that contains the current section.
    const sectionGroup = context.application.getActiveSection().parentSectionGroup;
            
    // Queue a command to load the section group.
    // For best performance, request specific properties.
    sectionGroup.load("id,name");
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Write the properties.
    console.log("Section group name: " + sectionGroup.name);
    console.log("Section group ID: " + sectionGroup.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.SectionGroup;

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

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

toJSON(): OneNote.Interfaces.SectionGroupData;

Devoluciones

OneNote.Interfaces.SectionGroupData

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

Devoluciones

OneNote.SectionGroup

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

Devoluciones

OneNote.SectionGroup