OneNote.SectionGroup class

A URL do cliente do grupo de seções.

readonly clientUrl: string;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Obtém o ID do grupo de seção.

readonly id: string;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o nome do grupo da seção.

readonly name: string;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o bloco de anotações que contém o grupo da seção.

readonly notebook: OneNote.Notebook;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o grupo da seção que contém o grupo da seção. Retorna ItemNotFound se o grupo da seção é um filho direto do bloco de anotações.

readonly parentSectionGroup: OneNote.SectionGroup;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o grupo da seção que contém o grupo da seção. Retorna nulo se a seção de grupo for um filho direto do bloco de anotações.

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

O conjunto de grupos de seção no grupo da seção.

readonly sectionGroups: OneNote.SectionGroupCollection;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

O conjunto de seções no grupo da seção.

readonly sections: OneNote.SectionCollection;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Adiciona uma nova seção ao final do grupo de seção.

addSection(title: string): OneNote.Section;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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();
});

Adiciona um novo grupo de seção ao final deste sectionGroup.

addSectionGroup(name: string): OneNote.SectionGroup;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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);
});

Obtém o ID da API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: OneNote.Interfaces.SectionGroupLoadOptions): OneNote.SectionGroup;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): OneNote.SectionGroup;

Parâmetros

Retornos

Exemplos

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);
});

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.SectionGroup;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original OneNote.SectionGroup é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.SectionGroupData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): OneNote.Interfaces.SectionGroupData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.

track(): OneNote.SectionGroup;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): OneNote.SectionGroup;

Retornos