OneNote.Notebook class
Representa um bloco de anotações do OneNote. Blocos de anotações contêm grupos de seções e seções.
- Extends
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Propriedades
| base |
O URL do site onde este bloco de notas está localizado. Somente leitura. |
| client |
A URL do cliente do bloco de anotações. Somente leitura. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| id | Obtém o ID do bloco de anotações. Somente leitura. |
| is |
Verdadeiro se o bloco de notas não for criado pelo utilizador (ou seja, "Secções no Local Incorreto"). |
| name | Obtém o nome do bloco de anotações. |
| section |
Obtém os grupos de seções no bloco de anotações. |
| sections | As seções no bloco de anotações. |
Métodos
| add |
Adiciona uma nova seção ao final do bloco de anotações. |
| add |
Adiciona um novo grupo de seção ao final do bloco de anotações. |
| get |
Obtém o ID da API REST. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
| track() | 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 |
| untrack() | 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 |
Detalhes da propriedade
baseUrl
O URL do site onde este bloco de notas está localizado. Somente leitura.
readonly baseUrl: string;Valor da propriedade
string
Comentários
clientUrl
A URL do cliente do bloco de anotações. Somente leitura.
readonly clientUrl: string;Valor da propriedade
string
Comentários
context
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
id
Obtém o ID do bloco de anotações. Somente leitura.
readonly id: string;Valor da propriedade
string
Comentários
isVirtual
Verdadeiro se o bloco de notas não for criado pelo utilizador (ou seja, "Secções no Local Incorreto").
readonly isVirtual: boolean;Valor da propriedade
boolean
Comentários
name
Obtém o nome do bloco de anotações.
readonly name: string;Valor da propriedade
string
Comentários
sectionGroups
Obtém os grupos de seções no bloco de anotações.
readonly sectionGroups: OneNote.SectionGroupCollection;Valor da propriedade
Comentários
sections
As seções no bloco de anotações.
readonly sections: OneNote.SectionCollection;Valor da propriedade
Comentários
Detalhes do método
addSection(name)
Adiciona uma nova seção ao final do bloco de anotações.
addSection(name: string): OneNote.Section;Parâmetros
- name
-
string
O nome da nova seção.
Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
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)
Adiciona um novo grupo de seção ao final do bloco de anotações.
addSectionGroup(name: string): OneNote.SectionGroup;Parâmetros
- name
-
string
O nome da nova seção.
Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
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()
Obtém o ID da API REST.
getRestApiId(): OfficeExtension.ClientResult<string>;Retornos
OfficeExtension.ClientResult<string>
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
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)
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.NotebookLoadOptions): OneNote.Notebook;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
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.Notebook;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
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)
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.Notebook;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
toJSON()
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.Notebook é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.NotebookData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): OneNote.Interfaces.NotebookData;Retornos
track()
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.Notebook;Retornos
untrack()
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.Notebook;