OneNote.Section class

A URL do cliente da seção.

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 a ID da seção.

readonly id: string;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Verdadeiro se esta secção estiver encriptada com uma palavra-passe.

readonly isEncrypted: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.2 ]

Verdadeiro se esta secção estiver bloqueada.

readonly isLocked: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.2 ]

Obtém o nome 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 a seção.

readonly notebook: OneNote.Notebook;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o conjunto de páginas da seção.

readonly pages: OneNote.PageCollection;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o grupo de seção que contém a seção. Retorna ItemNotFound se a 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 de seção que contém a seção. Retorna null se a seção for um filho direto do bloco de anotações. Somente leitura.

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

O URL da Web da página.

readonly webUrl: string;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Adiciona uma nova página ao final da seção.

addPage(title: string): OneNote.Page;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

Copia esta seção para o bloco de anotações especificado.

copyToNotebook(destinationNotebook: OneNote.Notebook): OneNote.Section;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

Copia esta seção para o grupo de seção especificado.

copyToSectionGroup(destinationSectionGroup: OneNote.SectionGroup): OneNote.Section;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

Obtém o ID da API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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://zcusa.951200.xyz/archive/blogs/onenotedev/and-sharepoint-makes-three
});

Insere uma nova seção antes ou depois da seção atual.

insertSectionAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Section;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Insere uma nova seção antes ou depois da seção atual.

insertSectionAsSibling(locationString: "Before" | "After", title: string): OneNote.Section;

Parâmetros

Retornos

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

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.SectionLoadOptions): OneNote.Section;

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

Parâmetros

Retornos

Exemplos

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

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

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.Section é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.SectionData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): OneNote.Interfaces.SectionData;

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

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

Retornos