OneNote.Application class
Representa o objeto de nível superior que contém todos os objetos do OneNote globalmente endereçados como blocos de anotações, o bloco de anotações ativo e a sessão ativa.
- Extends
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| notebooks | Obtém a coleção de blocos de notas abertos na instância do aplicativo OneNote. No OneNote Online, apenas um bloco de anotações de cada vez é aberto na instância do aplicativo. Somente leitura. |
Métodos
| get |
Obtém o bloco de anotações ativo, se houver um. Se não houver nenhum bloco de anotações ativo, gera ItemNotFound. |
| get |
Obtém o bloco de anotações ativo, se houver um. Se não houver nenhum bloco de anotações ativo, retorna nulo. |
| get |
Obtém a estrutura de tópicos ativa, se houver uma. Caso contrário, gera ItemNotFound. |
| get |
Obtém a estrutura de tópicos ativa, se houver uma; caso contrário, retorna nulo. |
| get |
Obtém a página ativa, se houver uma. Se não houver nenhuma página ativa, gera ItemNotFound. |
| get |
Obtém a página ativa, se houver uma. Se não houver nenhuma página ativa, retorna nulo. |
| get |
Obtém o Parágrafo ativo se existir um, se nenhum Parágrafo estiver ativo, será apresentado ItemNotFound. |
| get |
Obtém o Parágrafo ativo se existir, caso contrário, devolve nulo. |
| get |
Obtém a seção ativa, se houver uma. Se não houver nenhuma seção ativa, gera ItemNotFound. |
| get |
Obtém a seção ativa, se houver uma. Se não houver nenhuma seção ativa, retorna nulo. |
| get |
|
| get |
Obtém os traços de tinta digital selecionados atualmente. |
| get |
|
| insert |
|
| insert |
|
| is |
|
| 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 |
| navigate |
Abre a página especificada na instância do aplicativo. |
| navigate |
Obtém a página especificada e a abre na instância do aplicativo. A navegação pode ainda não ser efetuada quando não há falhas. O autor da chamada deve validar a página devolvida, se assim o desejar. |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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
notebooks
Obtém a coleção de blocos de notas abertos na instância do aplicativo OneNote. No OneNote Online, apenas um bloco de anotações de cada vez é aberto na instância do aplicativo. Somente leitura.
readonly notebooks: OneNote.NotebookCollection;Valor da propriedade
Comentários
Detalhes do método
getActiveNotebook()
Obtém o bloco de anotações ativo, se houver um. Se não houver nenhum bloco de anotações ativo, gera ItemNotFound.
getActiveNotebook(): OneNote.Notebook;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to load the notebook.
// For best performance, request specific properties.
notebook.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("Notebook name: " + notebook.name);
console.log("Notebook ID: " + notebook.id);
});
getActiveNotebookOrNull()
Obtém o bloco de anotações ativo, se houver um. Se não houver nenhum bloco de anotações ativo, retorna nulo.
getActiveNotebookOrNull(): OneNote.Notebook;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the active notebook.
const notebook = context.application.getActiveNotebookOrNull();
// Queue a command to load the notebook.
// For best performance, request specific properties.
notebook.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Check if active notebook is set.
if (!notebook.isNullObject) {
console.log("Notebook name: " + notebook.name);
console.log("Notebook ID: " + notebook.id);
}
});
getActiveOutline()
Obtém a estrutura de tópicos ativa, se houver uma. Caso contrário, gera ItemNotFound.
getActiveOutline(): OneNote.Outline;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// get active outline.
const outline = context.application.getActiveOutline();
// Queue a command to load the id of the outline.
outline.load('id');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("outline id: " + outline.id);
});
getActiveOutlineOrNull()
Obtém a estrutura de tópicos ativa, se houver uma; caso contrário, retorna nulo.
getActiveOutlineOrNull(): OneNote.Outline;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// get active outline.
const outline = context.application.getActiveOutlineOrNull();
// Queue a command to load the id of the outline.
outline.load('id');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (!outline.isNullObject) {
console.log("outline id: " + outline.id);
}
});
getActivePage()
Obtém a página ativa, se houver uma. Se não houver nenhuma página ativa, gera ItemNotFound.
getActivePage(): OneNote.Page;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the active page.
const page = context.application.getActivePage();
// Queue a command to load the page.
// For best performance, request specific properties.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("Page title: " + page.title);
console.log("Page ID: " + page.id);
});
getActivePageOrNull()
Obtém a página ativa, se houver uma. Se não houver nenhuma página ativa, retorna nulo.
getActivePageOrNull(): OneNote.Page;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the active page.
const page = context.application.getActivePageOrNull();
// Queue a command to load the page.
// For best performance, request specific properties.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (!page.isNullObject) {
// Show some properties.
console.log("Page title: " + page.title);
console.log("Page ID: " + page.id);
}
});
getActiveParagraph()
Obtém o Parágrafo ativo se existir um, se nenhum Parágrafo estiver ativo, será apresentado ItemNotFound.
getActiveParagraph(): OneNote.Paragraph;Retornos
Comentários
getActiveParagraphOrNull()
Obtém o Parágrafo ativo se existir, caso contrário, devolve nulo.
getActiveParagraphOrNull(): OneNote.Paragraph;Retornos
Comentários
getActiveSection()
Obtém a seção ativa, se houver uma. Se não houver nenhuma seção ativa, gera ItemNotFound.
getActiveSection(): OneNote.Section;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the active section.
const section = context.application.getActiveSection();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Show some properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
});
getActiveSectionOrNull()
Obtém a seção ativa, se houver uma. Se não houver nenhuma seção ativa, retorna nulo.
getActiveSectionOrNull(): OneNote.Section;Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the active section.
const section = context.application.getActiveSectionOrNull();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (!section.isNullObject) {
// Show some properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
}
});
getDecimalSeparator()
getDecimalSeparator(): OfficeExtension.ClientResult<string>;Retornos
OfficeExtension.ClientResult<string>
getSelectedInkStrokes()
Obtém os traços de tinta digital selecionados atualmente.
getSelectedInkStrokes(): OneNote.InkStrokeCollection;Retornos
Comentários
getWindowSize()
getWindowSize(): OfficeExtension.ClientResult<number[]>;Retornos
OfficeExtension.ClientResult<number[]>
insertAndEmbedLinkAtCurrentPosition(url)
insertAndEmbedLinkAtCurrentPosition(url: string): void;Parâmetros
- url
-
string
Retornos
void
insertHtmlAtCurrentPosition(html)
insertHtmlAtCurrentPosition(html: string): void;Parâmetros
- html
-
string
Retornos
void
isViewingDeletedNotes()
isViewingDeletedNotes(): OfficeExtension.ClientResult<boolean>;Retornos
OfficeExtension.ClientResult<boolean>
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.ApplicationLoadOptions): OneNote.Application;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.Application;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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.Application;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
navigateToPage(page)
Abre a página especificada na instância do aplicativo.
navigateToPage(page: OneNote.Page): void;Parâmetros
- page
- OneNote.Page
A página a ser aberta.
Retornos
void
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the pages in the current section.
const pages = context.application.getActiveSection().pages;
// Queue a command to load the pages.
// For best performance, request specific properties.
pages.load('id');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync()
// This example loads the first page in the section.
const page = pages.items[0];
// Open the page in the application.
context.application.navigateToPage(page);
// Run the queued command.
await context.sync();
});
navigateToPageWithClientUrl(url)
Obtém a página especificada e a abre na instância do aplicativo. A navegação pode ainda não ser efetuada quando não há falhas. O autor da chamada deve validar a página devolvida, se assim o desejar.
navigateToPageWithClientUrl(url: string): OneNote.Page;Parâmetros
- url
-
string
A URL do cliente da página a ser aberta.
Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the pages in the current section.
const pages = context.application.getActiveSection().pages;
// Queue a command to load the pages.
// For best performance, request specific properties.
pages.load('clientUrl');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync()
// This example loads the first page in the section.
const page = pages.items[0];
// Open the page in the application.
context.application.navigateToPageWithClientUrl(page.clientUrl);
// Run the queued command.
await context.sync();
});
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- OneNote.Interfaces.ApplicationUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: OneNote.Application): void;Parâmetros
- properties
- OneNote.Application
Retornos
void
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.Application é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.ApplicationData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): OneNote.Interfaces.ApplicationData;