onenote package

Classes

OneNote.Application	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.
OneNote.FloatingInk	Representa um grupo de traços de tinta.
OneNote.Image	Representa uma Imagem. Um Image pode ser um filho direto de um objeto PageContent ou Paragraph.
OneNote.InkAnalysis	Representa os dados de análise de tinta para um determinado conjunto de traços de tinta.
OneNote.InkAnalysisLine	Representa os dados da análise de tinta para uma linha de texto identificada formada por traços de tinta.
OneNote.InkAnalysisLineCollection	Representa uma coleção de objetos InkAnalysisLine.
OneNote.InkAnalysisParagraph	Representa os dados da análise de tinta para um parágrafo identificado formado por traços de tinta.
OneNote.InkAnalysisParagraphCollection	Representa um conjunto de objetos InkAnalysisParagraph.
OneNote.InkAnalysisWord	Representa os dados da análise de tinta para uma palavra identificada formada por traços de tinta.
OneNote.InkAnalysisWordCollection	Representa um conjunto de objetos InkAnalysisWord.
OneNote.InkStroke	Representa um único traço de tinta.
OneNote.InkStrokeCollection	Representa um conjunto de objetos InkStroke.
OneNote.InkWord	Um contêiner para a tinta em uma palavra em um parágrafo.
OneNote.InkWordCollection	Representa um conjunto de objetos InkWord.
OneNote.Notebook	Representa um bloco de anotações do OneNote. Blocos de anotações contêm grupos de seções e seções.
OneNote.NotebookCollection	Representa uma coleção de bloco de anotações.
OneNote.NoteTag	Um contentor para o NoteTag num parágrafo.
OneNote.Outline	Representa um contêiner para objetos Paragraph.
OneNote.Page	Representa uma página do OneNote.
OneNote.PageCollection	Representa uma coleção de páginas.
OneNote.PageContent	Representa uma região em uma página que contém os tipos de conteúdo de nível superior como estrutura de tópicos ou imagem. Um objeto PageContent pode ser atribuído a uma posição XY.
OneNote.PageContentCollection	Representa o conteúdo de uma página, como um conjunto de objetos PageContent.
OneNote.Paragraph	Um contêiner para o conteúdo visível em uma página. Um parágrafo pode conter qualquer tipo de ParagraphType de conteúdo.
OneNote.ParagraphCollection	Representa um conjunto de objetos Paragraph.
OneNote.Point	Representa um único ponto de traço de tinta digital
OneNote.PointCollection	Representa uma coleção de objetos Point.
OneNote.RequestContext
OneNote.RichText	Representa um objeto RichText em um Paragraph.
OneNote.Section	Representa uma seção do OneNote. As seções podem conter páginas.
OneNote.SectionCollection	Representa um conjunto de seções.
OneNote.SectionGroup	Representa um grupo de seção do OneNote. Grupos de seções podem conter seções e outros grupos de seções.
OneNote.SectionGroupCollection	Representa um conjunto de grupo de seções.
OneNote.Table	Representa uma tabela em uma página do OneNote.
OneNote.TableCell	Representa uma célula em uma tabela do OneNote.
OneNote.TableCellCollection	Contém um conjunto de objetos TableCell.
OneNote.TableRow	Representa uma linha em uma tabela.
OneNote.TableRowCollection	Contém um conjunto de objetos TableRow.

Interfaces

OneNote.ImageOcrData	Representa os dados obtidos pelo OCR (reconhecimento ótico de carateres) de uma imagem.
OneNote.InkStrokePointer	Referência fraca a um objeto de traço de tinta digital e ao respetivo conteúdo principal.
OneNote.Interfaces.ApplicationData	Uma interface que descreve os dados devolvidos ao chamar application.toJSON().
OneNote.Interfaces.ApplicationLoadOptions	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.
OneNote.Interfaces.ApplicationUpdateData	Uma interface para atualizar dados no Application objeto, para utilização no application.set({ ... }).
OneNote.Interfaces.CollectionLoadOptions	Fornece formas de carregar propriedades de apenas um subconjunto de membros de uma coleção.
OneNote.Interfaces.FloatingInkData	Uma interface que descreve os dados devolvidos ao chamar floatingInk.toJSON().
OneNote.Interfaces.FloatingInkLoadOptions	Representa um grupo de traços de tinta.
OneNote.Interfaces.ImageData	Uma interface que descreve os dados devolvidos ao chamar image.toJSON().
OneNote.Interfaces.ImageLoadOptions	Representa uma Imagem. Um Image pode ser um filho direto de um objeto PageContent ou Paragraph.
OneNote.Interfaces.ImageUpdateData	Uma interface para atualizar dados no Image objeto, para utilização no image.set({ ... }).
OneNote.Interfaces.InkAnalysisData	Uma interface que descreve os dados devolvidos ao chamar inkAnalysis.toJSON().
OneNote.Interfaces.InkAnalysisLineCollectionData	Uma interface que descreve os dados devolvidos ao chamar inkAnalysisLineCollection.toJSON().
OneNote.Interfaces.InkAnalysisLineCollectionLoadOptions	Representa uma coleção de objetos InkAnalysisLine.
OneNote.Interfaces.InkAnalysisLineCollectionUpdateData	Uma interface para atualizar dados no InkAnalysisLineCollection objeto, para utilização no inkAnalysisLineCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisLineData	Uma interface que descreve os dados devolvidos ao chamar inkAnalysisLine.toJSON().
OneNote.Interfaces.InkAnalysisLineLoadOptions	Representa os dados da análise de tinta para uma linha de texto identificada formada por traços de tinta.
OneNote.Interfaces.InkAnalysisLineUpdateData	Uma interface para atualizar dados no InkAnalysisLine objeto, para utilização no inkAnalysisLine.set({ ... }).
OneNote.Interfaces.InkAnalysisLoadOptions	Representa os dados de análise de tinta para um determinado conjunto de traços de tinta.
OneNote.Interfaces.InkAnalysisParagraphCollectionData	Uma interface que descreve os dados devolvidos ao chamar inkAnalysisParagraphCollection.toJSON().
OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions	Representa um conjunto de objetos InkAnalysisParagraph.
OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData	Uma interface para atualizar dados no InkAnalysisParagraphCollection objeto, para utilização no inkAnalysisParagraphCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisParagraphData	Uma interface que descreve os dados devolvidos ao chamar inkAnalysisParagraph.toJSON().
OneNote.Interfaces.InkAnalysisParagraphLoadOptions	Representa os dados da análise de tinta para um parágrafo identificado formado por traços de tinta.
OneNote.Interfaces.InkAnalysisParagraphUpdateData	Uma interface para atualizar dados no InkAnalysisParagraph objeto, para utilização no inkAnalysisParagraph.set({ ... }).
OneNote.Interfaces.InkAnalysisUpdateData	Uma interface para atualizar dados no InkAnalysis objeto, para utilização no inkAnalysis.set({ ... }).
OneNote.Interfaces.InkAnalysisWordCollectionData	Uma interface que descreve os dados devolvidos ao chamar inkAnalysisWordCollection.toJSON().
OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions	Representa um conjunto de objetos InkAnalysisWord.
OneNote.Interfaces.InkAnalysisWordCollectionUpdateData	Uma interface para atualizar dados no InkAnalysisWordCollection objeto, para utilização no inkAnalysisWordCollection.set({ ... }).
OneNote.Interfaces.InkAnalysisWordData	Uma interface que descreve os dados devolvidos ao chamar inkAnalysisWord.toJSON().
OneNote.Interfaces.InkAnalysisWordLoadOptions	Representa os dados da análise de tinta para uma palavra identificada formada por traços de tinta.
OneNote.Interfaces.InkAnalysisWordUpdateData	Uma interface para atualizar dados no InkAnalysisWord objeto, para utilização no inkAnalysisWord.set({ ... }).
OneNote.Interfaces.InkStrokeCollectionData	Uma interface que descreve os dados devolvidos ao chamar inkStrokeCollection.toJSON().
OneNote.Interfaces.InkStrokeCollectionLoadOptions	Representa um conjunto de objetos InkStroke.
OneNote.Interfaces.InkStrokeCollectionUpdateData	Uma interface para atualizar dados no InkStrokeCollection objeto, para utilização no inkStrokeCollection.set({ ... }).
OneNote.Interfaces.InkStrokeData	Uma interface que descreve os dados devolvidos ao chamar inkStroke.toJSON().
OneNote.Interfaces.InkStrokeLoadOptions	Representa um único traço de tinta.
OneNote.Interfaces.InkWordCollectionData	Uma interface que descreve os dados devolvidos ao chamar inkWordCollection.toJSON().
OneNote.Interfaces.InkWordCollectionLoadOptions	Representa um conjunto de objetos InkWord.
OneNote.Interfaces.InkWordCollectionUpdateData	Uma interface para atualizar dados no InkWordCollection objeto, para utilização no inkWordCollection.set({ ... }).
OneNote.Interfaces.InkWordData	Uma interface que descreve os dados devolvidos ao chamar inkWord.toJSON().
OneNote.Interfaces.InkWordLoadOptions	Um contêiner para a tinta em uma palavra em um parágrafo.
OneNote.Interfaces.NotebookCollectionData	Uma interface que descreve os dados devolvidos ao chamar notebookCollection.toJSON().
OneNote.Interfaces.NotebookCollectionLoadOptions	Representa uma coleção de bloco de anotações.
OneNote.Interfaces.NotebookCollectionUpdateData	Uma interface para atualizar dados no NotebookCollection objeto, para utilização no notebookCollection.set({ ... }).
OneNote.Interfaces.NotebookData	Uma interface que descreve os dados devolvidos ao chamar notebook.toJSON().
OneNote.Interfaces.NotebookLoadOptions	Representa um bloco de anotações do OneNote. Blocos de anotações contêm grupos de seções e seções.
OneNote.Interfaces.NoteTagData	Uma interface que descreve os dados devolvidos ao chamar noteTag.toJSON().
OneNote.Interfaces.NoteTagLoadOptions	Um contentor para o NoteTag num parágrafo.
OneNote.Interfaces.OutlineData	Uma interface que descreve os dados devolvidos ao chamar outline.toJSON().
OneNote.Interfaces.OutlineLoadOptions	Representa um contêiner para objetos Paragraph.
OneNote.Interfaces.PageCollectionData	Uma interface que descreve os dados devolvidos ao chamar pageCollection.toJSON().
OneNote.Interfaces.PageCollectionLoadOptions	Representa uma coleção de páginas.
OneNote.Interfaces.PageCollectionUpdateData	Uma interface para atualizar dados no PageCollection objeto, para utilização no pageCollection.set({ ... }).
OneNote.Interfaces.PageContentCollectionData	Uma interface que descreve os dados devolvidos ao chamar pageContentCollection.toJSON().
OneNote.Interfaces.PageContentCollectionLoadOptions	Representa o conteúdo de uma página, como um conjunto de objetos PageContent.
OneNote.Interfaces.PageContentCollectionUpdateData	Uma interface para atualizar dados no PageContentCollection objeto, para utilização no pageContentCollection.set({ ... }).
OneNote.Interfaces.PageContentData	Uma interface que descreve os dados devolvidos ao chamar pageContent.toJSON().
OneNote.Interfaces.PageContentLoadOptions	Representa uma região em uma página que contém os tipos de conteúdo de nível superior como estrutura de tópicos ou imagem. Um objeto PageContent pode ser atribuído a uma posição XY.
OneNote.Interfaces.PageContentUpdateData	Uma interface para atualizar dados no PageContent objeto, para utilização no pageContent.set({ ... }).
OneNote.Interfaces.PageData	Uma interface que descreve os dados devolvidos ao chamar page.toJSON().
OneNote.Interfaces.PageLoadOptions	Representa uma página do OneNote.
OneNote.Interfaces.PageUpdateData	Uma interface para atualizar dados no Page objeto, para utilização no page.set({ ... }).
OneNote.Interfaces.ParagraphCollectionData	Uma interface que descreve os dados devolvidos ao chamar paragraphCollection.toJSON().
OneNote.Interfaces.ParagraphCollectionLoadOptions	Representa um conjunto de objetos Paragraph.
OneNote.Interfaces.ParagraphCollectionUpdateData	Uma interface para atualizar dados no objeto ParagraphCollection, para utilização no paragraphCollection.set({ ... }).
OneNote.Interfaces.ParagraphData	Uma interface que descreve os dados devolvidos ao chamar paragraph.toJSON().
OneNote.Interfaces.ParagraphLoadOptions	Um contêiner para o conteúdo visível em uma página. Um parágrafo pode conter qualquer tipo de ParagraphType de conteúdo.
OneNote.Interfaces.ParagraphUpdateData	Uma interface para atualizar dados no Paragraph objeto, para utilização no paragraph.set({ ... }).
OneNote.Interfaces.PointCollectionData	Uma interface que descreve os dados devolvidos ao chamar pointCollection.toJSON().
OneNote.Interfaces.PointCollectionLoadOptions	Representa uma coleção de objetos Point.
OneNote.Interfaces.PointCollectionUpdateData	Uma interface para atualizar dados no PointCollection objeto, para utilização no pointCollection.set({ ... }).
OneNote.Interfaces.PointData	Uma interface que descreve os dados devolvidos ao chamar point.toJSON().
OneNote.Interfaces.PointLoadOptions	Representa um único ponto de traço de tinta digital
OneNote.Interfaces.RichTextData	Uma interface que descreve os dados devolvidos ao chamar richText.toJSON().
OneNote.Interfaces.RichTextLoadOptions	Representa um objeto RichText em um Paragraph.
OneNote.Interfaces.SectionCollectionData	Uma interface que descreve os dados devolvidos ao chamar sectionCollection.toJSON().
OneNote.Interfaces.SectionCollectionLoadOptions	Representa um conjunto de seções.
OneNote.Interfaces.SectionCollectionUpdateData	Uma interface para atualizar dados no SectionCollection objeto, para utilização no sectionCollection.set({ ... }).
OneNote.Interfaces.SectionData	Uma interface que descreve os dados devolvidos ao chamar section.toJSON().
OneNote.Interfaces.SectionGroupCollectionData	Uma interface que descreve os dados devolvidos ao chamar sectionGroupCollection.toJSON().
OneNote.Interfaces.SectionGroupCollectionLoadOptions	Representa um conjunto de grupo de seções.
OneNote.Interfaces.SectionGroupCollectionUpdateData	Uma interface para atualizar dados no SectionGroupCollection objeto, para utilização no sectionGroupCollection.set({ ... }).
OneNote.Interfaces.SectionGroupData	Uma interface que descreve os dados devolvidos ao chamar sectionGroup.toJSON().
OneNote.Interfaces.SectionGroupLoadOptions	Representa um grupo de seção do OneNote. Grupos de seções podem conter seções e outros grupos de seções.
OneNote.Interfaces.SectionLoadOptions	Representa uma seção do OneNote. As seções podem conter páginas.
OneNote.Interfaces.TableCellCollectionData	Uma interface que descreve os dados devolvidos ao chamar tableCellCollection.toJSON().
OneNote.Interfaces.TableCellCollectionLoadOptions	Contém um conjunto de objetos TableCell.
OneNote.Interfaces.TableCellCollectionUpdateData	Uma interface para atualizar dados no TableCellCollection objeto, para utilização no tableCellCollection.set({ ... }).
OneNote.Interfaces.TableCellData	Uma interface que descreve os dados devolvidos ao chamar tableCell.toJSON().
OneNote.Interfaces.TableCellLoadOptions	Representa uma célula em uma tabela do OneNote.
OneNote.Interfaces.TableCellUpdateData	Uma interface para atualizar dados no TableCell objeto, para utilização no tableCell.set({ ... }).
OneNote.Interfaces.TableData	Uma interface que descreve os dados devolvidos ao chamar table.toJSON().
OneNote.Interfaces.TableLoadOptions	Representa uma tabela em uma página do OneNote.
OneNote.Interfaces.TableRowCollectionData	Uma interface que descreve os dados devolvidos ao chamar tableRowCollection.toJSON().
OneNote.Interfaces.TableRowCollectionLoadOptions	Contém um conjunto de objetos TableRow.
OneNote.Interfaces.TableRowCollectionUpdateData	Uma interface para atualizar dados no TableRowCollection objeto, para utilização no tableRowCollection.set({ ... }).
OneNote.Interfaces.TableRowData	Uma interface que descreve os dados devolvidos ao chamar tableRow.toJSON().
OneNote.Interfaces.TableRowLoadOptions	Representa uma linha em uma tabela.
OneNote.Interfaces.TableUpdateData	Uma interface para atualizar dados no Table objeto, para utilização no table.set({ ... }).
OneNote.ParagraphInfo	Listar informações para parágrafo.

Enumerações

OneNote.ErrorCodes

OneNote.EventType

OneNote.InsertLocation

OneNote.ListType

OneNote.NoteTagStatus

OneNote.NoteTagType

OneNote.NumberType

OneNote.PageContentType

OneNote.ParagraphStyle

OneNote.ParagraphType

Funções

OneNote.run(batch)	Executa um script de lote que executa ações no modelo de objeto do OneNote com um novo contexto de pedido. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.
OneNote.run(object, batch)	Executa um script de lote que executa ações no modelo de objeto do OneNote com o contexto de pedido de um objeto de API criado anteriormente.
OneNote.run(objects, batch)	Executa um script de lote que executa ações no modelo de objeto do OneNote, com o contexto de pedido de objetos de API criados anteriormente.

Detalhes da função

OneNote.run(batch)

Executa um script de lote que executa ações no modelo de objeto do OneNote com um novo contexto de pedido. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

export function run<T>(batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

Parâmetros

batch

(context: OneNote.RequestContext) => Promise<T>

Uma função que recebe um OneNote.RequestContext e devolve uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita os pedidos para a aplicação OneNote. Uma vez que o suplemento do Office e a aplicação OneNote são executados em dois processos diferentes, o contexto do pedido é necessário para obter acesso ao modelo de objetos do OneNote a partir do suplemento.

Retornos

Promise<T>

OneNote.run(object, batch)

Executa um script de lote que executa ações no modelo de objeto do OneNote com o contexto de pedido de um objeto de API criado anteriormente.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

Parâmetros

object

OfficeExtension.ClientObject

Um objeto de API criado anteriormente. O lote utilizará o mesmo contexto de pedido que o objeto transmitido, o que significa que todas as alterações aplicadas ao objeto serão recolhidas por "context.sync()".

batch

(context: OneNote.RequestContext) => Promise<T>

Uma função que recebe um OneNote.RequestContext e devolve uma promessa (normalmente, apenas o resultado de "context.sync()"). Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

Retornos

Promise<T>

OneNote.run(objects, batch)

Executa um script de lote que executa ações no modelo de objeto do OneNote, com o contexto de pedido de objetos de API criados anteriormente.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

Parâmetros

objects

OfficeExtension.ClientObject[]

batch

(context: OneNote.RequestContext) => Promise<T>

Uma função que recebe um OneNote.RequestContext e devolve uma promessa (normalmente, apenas o resultado de "context.sync()"). Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

Retornos

Promise<T>