onenote package

Classes

OneNote.Application

Représente l’objet de niveau supérieur qui contient tous les objets OneNote globalement adressables tels que les blocs-notes, le bloc-note actif et la section active.

OneNote.FloatingInk

Représente un groupe de traits d’encre.

OneNote.Image

Représente une image. Une image peut être un enfant direct d’un objet PageContent ou Paragraph.

OneNote.InkAnalysis

Représente les données d’analyse des entrées manuscrites pour un ensemble de traits d’encre.

OneNote.InkAnalysisLine

Représente les données d’analyse des entrées manuscrites pour une ligne de texte identifiée formée de traits d’encre.

OneNote.InkAnalysisLineCollection

Représente une collection d’objets InkAnalysisLine.

OneNote.InkAnalysisParagraph

Représente les données d’analyse des entrées manuscrites pour un paragraphe identifié formé de traits d’encre.

OneNote.InkAnalysisParagraphCollection

Représente une collection d’objets InkAnalysisParagraph.

OneNote.InkAnalysisWord

Représente les données d’analyse des entrées manuscrites pour un mot identifié formé de traits d’encre.

OneNote.InkAnalysisWordCollection

Représente une collection d’objets InkAnalysisWord.

OneNote.InkStroke

Représente un seul trait d’encre.

OneNote.InkStrokeCollection

Représente une collection d’objets InkStroke.

OneNote.InkWord

Conteneur de l’entrée manuscrite d’un mot dans un paragraphe.

OneNote.InkWordCollection

Représente une collection d’objets InkWord.

OneNote.Notebook

Représente un bloc-notes OneNote. Les blocs-notes contiennent des groupes de sections et des sections.

OneNote.NotebookCollection

Représente une collection de blocs-notes.

OneNote.NoteTag

Conteneur pour le NoteTag dans un paragraphe.

OneNote.Outline

Représente un conteneur pour les objets Paragraph.

OneNote.Page

Représente une page OneNote.

OneNote.PageCollection

Représente une collection de pages.

OneNote.PageContent

Représente une zone sur une page qui contient des types de contenu de niveau supérieur tels que des plans ou des images. Un objet PageContent peut être affecté à une position XY.

OneNote.PageContentCollection

Représente le contenu d’une page, sous la forme d’une collection d’objets PageContent.

OneNote.Paragraph

Conteneur pour le contenu visible d’une page. Un paragraphe peut contenir n’importe quel type de contenu ParagraphType.

OneNote.ParagraphCollection

Représente une collection d’objets Paragraph.

OneNote.Point

Représente un point unique de trait d’entrée manuscrite

OneNote.PointCollection

Représente une collection d’objets Point.

OneNote.RequestContext
OneNote.RichText

Représente un objet RichText dans un paragraphe.

OneNote.Section

Représente une section OneNote. Les sections peuvent contenir des pages.

OneNote.SectionCollection

Représente une collection de sections.

OneNote.SectionGroup

Représente un groupe de sections OneNote. Les groupes de sections peuvent contenir des sections et des groupes de sections.

OneNote.SectionGroupCollection

Représente une collection de groupes de sections.

OneNote.Table

Représente une table dans une page OneNote.

OneNote.TableCell

Représente une cellule dans un tableau OneNote.

OneNote.TableCellCollection

Contient une collection d’objets TableCell.

OneNote.TableRow

Représente une ligne dans un tableau.

OneNote.TableRowCollection

Contient une collection d’objets TableRow.

Interfaces

OneNote.ImageOcrData

Représente les données obtenues par la reconnaissance optique de caractères (OCR) d’une image.

OneNote.InkStrokePointer

Référence faible à un objet trait d’encre et à son parent de contenu.

OneNote.Interfaces.ApplicationData

Interface décrivant les données retournées en appelant application.toJSON().

OneNote.Interfaces.ApplicationLoadOptions

Représente l’objet de niveau supérieur qui contient tous les objets OneNote globalement adressables tels que les blocs-notes, le bloc-note actif et la section active.

OneNote.Interfaces.ApplicationUpdateData

Interface pour la mise à jour des données sur l’objet Application, à utiliser dans application.set({ ... }).

OneNote.Interfaces.CollectionLoadOptions

Fournit des moyens de charger les propriétés d’un sous-ensemble de membres d’une collection uniquement.

OneNote.Interfaces.FloatingInkData

Interface décrivant les données retournées en appelant floatingInk.toJSON().

OneNote.Interfaces.FloatingInkLoadOptions

Représente un groupe de traits d’encre.

OneNote.Interfaces.ImageData

Interface décrivant les données retournées en appelant image.toJSON().

OneNote.Interfaces.ImageLoadOptions

Représente une image. Une image peut être un enfant direct d’un objet PageContent ou Paragraph.

OneNote.Interfaces.ImageUpdateData

Interface pour la mise à jour des données sur l’objet Image, à utiliser dans image.set({ ... }).

OneNote.Interfaces.InkAnalysisData

Interface décrivant les données retournées en appelant inkAnalysis.toJSON().

OneNote.Interfaces.InkAnalysisLineCollectionData

Interface décrivant les données retournées en appelant inkAnalysisLineCollection.toJSON().

OneNote.Interfaces.InkAnalysisLineCollectionLoadOptions

Représente une collection d’objets InkAnalysisLine.

OneNote.Interfaces.InkAnalysisLineCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet InkAnalysisLineCollection, à utiliser dans inkAnalysisLineCollection.set({ ... }).

OneNote.Interfaces.InkAnalysisLineData

Interface décrivant les données retournées en appelant inkAnalysisLine.toJSON().

OneNote.Interfaces.InkAnalysisLineLoadOptions

Représente les données d’analyse des entrées manuscrites pour une ligne de texte identifiée formée de traits d’encre.

OneNote.Interfaces.InkAnalysisLineUpdateData

Interface permettant de mettre à jour les données sur l’objet InkAnalysisLine, à utiliser dans inkAnalysisLine.set({ ... }).

OneNote.Interfaces.InkAnalysisLoadOptions

Représente les données d’analyse des entrées manuscrites pour un ensemble de traits d’encre.

OneNote.Interfaces.InkAnalysisParagraphCollectionData

Interface décrivant les données retournées en appelant inkAnalysisParagraphCollection.toJSON().

OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions

Représente une collection d’objets InkAnalysisParagraph.

OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet InkAnalysisParagraphCollection, à utiliser dans inkAnalysisParagraphCollection.set({ ... }).

OneNote.Interfaces.InkAnalysisParagraphData

Interface décrivant les données retournées en appelant inkAnalysisParagraph.toJSON().

OneNote.Interfaces.InkAnalysisParagraphLoadOptions

Représente les données d’analyse des entrées manuscrites pour un paragraphe identifié formé de traits d’encre.

OneNote.Interfaces.InkAnalysisParagraphUpdateData

Interface pour la mise à jour des données sur l’objet InkAnalysisParagraph, à utiliser dans inkAnalysisParagraph.set({ ... }).

OneNote.Interfaces.InkAnalysisUpdateData

Interface pour la mise à jour des données sur l’objet InkAnalysis, à utiliser dans inkAnalysis.set({ ... }).

OneNote.Interfaces.InkAnalysisWordCollectionData

Interface décrivant les données retournées en appelant inkAnalysisWordCollection.toJSON().

OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions

Représente une collection d’objets InkAnalysisWord.

OneNote.Interfaces.InkAnalysisWordCollectionUpdateData

Interface pour la mise à jour des données sur l’objet InkAnalysisWordCollection, à utiliser dans inkAnalysisWordCollection.set({ ... }).

OneNote.Interfaces.InkAnalysisWordData

Interface décrivant les données retournées en appelant inkAnalysisWord.toJSON().

OneNote.Interfaces.InkAnalysisWordLoadOptions

Représente les données d’analyse des entrées manuscrites pour un mot identifié formé de traits d’encre.

OneNote.Interfaces.InkAnalysisWordUpdateData

Interface pour la mise à jour des données sur l’objet InkAnalysisWord, à utiliser dans inkAnalysisWord.set({ ... }).

OneNote.Interfaces.InkStrokeCollectionData

Interface décrivant les données retournées en appelant inkStrokeCollection.toJSON().

OneNote.Interfaces.InkStrokeCollectionLoadOptions

Représente une collection d’objets InkStroke.

OneNote.Interfaces.InkStrokeCollectionUpdateData

Interface pour la mise à jour des données sur l’objet InkStrokeCollection, à utiliser dans inkStrokeCollection.set({ ... }).

OneNote.Interfaces.InkStrokeData

Interface décrivant les données retournées en appelant inkStroke.toJSON().

OneNote.Interfaces.InkStrokeLoadOptions

Représente un seul trait d’encre.

OneNote.Interfaces.InkWordCollectionData

Interface décrivant les données retournées en appelant inkWordCollection.toJSON().

OneNote.Interfaces.InkWordCollectionLoadOptions

Représente une collection d’objets InkWord.

OneNote.Interfaces.InkWordCollectionUpdateData

Interface pour la mise à jour des données sur l’objet InkWordCollection, à utiliser dans inkWordCollection.set({ ... }).

OneNote.Interfaces.InkWordData

Interface décrivant les données retournées en appelant inkWord.toJSON().

OneNote.Interfaces.InkWordLoadOptions

Conteneur de l’entrée manuscrite d’un mot dans un paragraphe.

OneNote.Interfaces.NotebookCollectionData

Interface décrivant les données retournées en appelant notebookCollection.toJSON().

OneNote.Interfaces.NotebookCollectionLoadOptions

Représente une collection de blocs-notes.

OneNote.Interfaces.NotebookCollectionUpdateData

Interface pour la mise à jour des données sur l’objet NotebookCollection, à utiliser dans notebookCollection.set({ ... }).

OneNote.Interfaces.NotebookData

Interface décrivant les données retournées en appelant notebook.toJSON().

OneNote.Interfaces.NotebookLoadOptions

Représente un bloc-notes OneNote. Les blocs-notes contiennent des groupes de sections et des sections.

OneNote.Interfaces.NoteTagData

Interface décrivant les données retournées en appelant noteTag.toJSON().

OneNote.Interfaces.NoteTagLoadOptions

Conteneur pour le NoteTag dans un paragraphe.

OneNote.Interfaces.OutlineData

Interface décrivant les données retournées en appelant outline.toJSON().

OneNote.Interfaces.OutlineLoadOptions

Représente un conteneur pour les objets Paragraph.

OneNote.Interfaces.PageCollectionData

Interface décrivant les données retournées en appelant pageCollection.toJSON().

OneNote.Interfaces.PageCollectionLoadOptions

Représente une collection de pages.

OneNote.Interfaces.PageCollectionUpdateData

Interface pour la mise à jour des données sur l’objet PageCollection, à utiliser dans pageCollection.set({ ... }).

OneNote.Interfaces.PageContentCollectionData

Interface décrivant les données retournées en appelant pageContentCollection.toJSON().

OneNote.Interfaces.PageContentCollectionLoadOptions

Représente le contenu d’une page, sous la forme d’une collection d’objets PageContent.

OneNote.Interfaces.PageContentCollectionUpdateData

Interface pour la mise à jour des données sur l’objet PageContentCollection, à utiliser dans pageContentCollection.set({ ... }).

OneNote.Interfaces.PageContentData

Interface décrivant les données retournées en appelant pageContent.toJSON().

OneNote.Interfaces.PageContentLoadOptions

Représente une zone sur une page qui contient des types de contenu de niveau supérieur tels que des plans ou des images. Un objet PageContent peut être affecté à une position XY.

OneNote.Interfaces.PageContentUpdateData

Interface permettant de mettre à jour les données sur l’objet PageContent, à utiliser dans pageContent.set({ ... }).

OneNote.Interfaces.PageData

Interface décrivant les données retournées en appelant page.toJSON().

OneNote.Interfaces.PageLoadOptions

Représente une page OneNote.

OneNote.Interfaces.PageUpdateData

Interface pour la mise à jour des données sur l’objet Page, à utiliser dans page.set({ ... }).

OneNote.Interfaces.ParagraphCollectionData

Interface décrivant les données retournées en appelant paragraphCollection.toJSON().

OneNote.Interfaces.ParagraphCollectionLoadOptions

Représente une collection d’objets Paragraph.

OneNote.Interfaces.ParagraphCollectionUpdateData

Interface pour la mise à jour des données sur l’objet ParagraphCollection, à utiliser dans paragraphCollection.set({ ... }).

OneNote.Interfaces.ParagraphData

Interface décrivant les données retournées en appelant paragraph.toJSON().

OneNote.Interfaces.ParagraphLoadOptions

Conteneur pour le contenu visible d’une page. Un paragraphe peut contenir n’importe quel type de contenu ParagraphType.

OneNote.Interfaces.ParagraphUpdateData

Interface pour la mise à jour des données sur l’objet Paragraph, à utiliser dans paragraph.set({ ... }).

OneNote.Interfaces.PointCollectionData

Interface décrivant les données retournées en appelant pointCollection.toJSON().

OneNote.Interfaces.PointCollectionLoadOptions

Représente une collection d’objets Point.

OneNote.Interfaces.PointCollectionUpdateData

Interface pour la mise à jour des données sur l’objet PointCollection, à utiliser dans pointCollection.set({ ... }).

OneNote.Interfaces.PointData

Interface décrivant les données retournées en appelant point.toJSON().

OneNote.Interfaces.PointLoadOptions

Représente un point unique de trait d’entrée manuscrite

OneNote.Interfaces.RichTextData

Interface décrivant les données retournées en appelant richText.toJSON().

OneNote.Interfaces.RichTextLoadOptions

Représente un objet RichText dans un paragraphe.

OneNote.Interfaces.SectionCollectionData

Interface décrivant les données retournées en appelant sectionCollection.toJSON().

OneNote.Interfaces.SectionCollectionLoadOptions

Représente une collection de sections.

OneNote.Interfaces.SectionCollectionUpdateData

Interface pour la mise à jour des données sur l’objet SectionCollection, à utiliser dans sectionCollection.set({ ... }).

OneNote.Interfaces.SectionData

Interface décrivant les données retournées en appelant section.toJSON().

OneNote.Interfaces.SectionGroupCollectionData

Interface décrivant les données retournées en appelant sectionGroupCollection.toJSON().

OneNote.Interfaces.SectionGroupCollectionLoadOptions

Représente une collection de groupes de sections.

OneNote.Interfaces.SectionGroupCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet SectionGroupCollection, à utiliser dans sectionGroupCollection.set({ ... }).

OneNote.Interfaces.SectionGroupData

Interface décrivant les données retournées en appelant sectionGroup.toJSON().

OneNote.Interfaces.SectionGroupLoadOptions

Représente un groupe de sections OneNote. Les groupes de sections peuvent contenir des sections et des groupes de sections.

OneNote.Interfaces.SectionLoadOptions

Représente une section OneNote. Les sections peuvent contenir des pages.

OneNote.Interfaces.TableCellCollectionData

Interface décrivant les données retournées en appelant tableCellCollection.toJSON().

OneNote.Interfaces.TableCellCollectionLoadOptions

Contient une collection d’objets TableCell.

OneNote.Interfaces.TableCellCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet TableCellCollection, à utiliser dans tableCellCollection.set({ ... }).

OneNote.Interfaces.TableCellData

Interface décrivant les données retournées en appelant tableCell.toJSON().

OneNote.Interfaces.TableCellLoadOptions

Représente une cellule dans un tableau OneNote.

OneNote.Interfaces.TableCellUpdateData

Interface pour la mise à jour des données sur l’objet TableCell, à utiliser dans tableCell.set({ ... }).

OneNote.Interfaces.TableData

Interface décrivant les données retournées en appelant table.toJSON().

OneNote.Interfaces.TableLoadOptions

Représente une table dans une page OneNote.

OneNote.Interfaces.TableRowCollectionData

Interface décrivant les données retournées en appelant tableRowCollection.toJSON().

OneNote.Interfaces.TableRowCollectionLoadOptions

Contient une collection d’objets TableRow.

OneNote.Interfaces.TableRowCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet TableRowCollection, à utiliser dans tableRowCollection.set({ ... }).

OneNote.Interfaces.TableRowData

Interface décrivant les données retournées en appelant tableRow.toJSON().

OneNote.Interfaces.TableRowLoadOptions

Représente une ligne dans un tableau.

OneNote.Interfaces.TableUpdateData

Interface pour la mise à jour des données sur l’objet Table, à utiliser dans table.set({ ... }).

OneNote.ParagraphInfo

Répertorier les informations du paragraphe.

Énumérations

OneNote.ErrorCodes
OneNote.EventType
OneNote.InsertLocation
OneNote.ListType
OneNote.NoteTagStatus
OneNote.NoteTagType
OneNote.NumberType
OneNote.PageContentType
OneNote.ParagraphStyle
OneNote.ParagraphType

Fonctions

OneNote.run(batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet OneNote à l’aide d’un nouveau contexte de requête. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

OneNote.run(object, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet OneNote, à l’aide du contexte de requête d’un objet API créé précédemment.

OneNote.run(objects, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet OneNote, à l’aide du contexte de requête des objets API créés précédemment.

Informations relatives à la fonction

OneNote.run(batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet OneNote à l’aide d’un nouveau contexte de requête. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

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

Paramètres

batch

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

Fonction qui prend un OneNote.RequestContext et retourne une promesse (généralement, juste le résultat de « context.sync() »). Le paramètre de contexte facilite les demandes adressées à l’application OneNote. Étant donné que le complément Office et l’application OneNote s’exécutent dans deux processus différents, le contexte de demande est nécessaire pour accéder au modèle objet OneNote à partir du complément.

Retours

Promise<T>

OneNote.run(object, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet OneNote, à l’aide du contexte de requête d’un objet API créé précédemment.

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

Paramètres

object
OfficeExtension.ClientObject

Objet API créé précédemment. Le lot utilise le même contexte de requête que l’objet passé, ce qui signifie que toutes les modifications appliquées à l’objet seront récupérées par « context.sync() ».

batch

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

Fonction qui prend un OneNote.RequestContext et retourne une promesse (généralement, juste le résultat de « context.sync() »). Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

Retours

Promise<T>

OneNote.run(objects, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet OneNote, à l’aide du contexte de requête des objets API créés précédemment.

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

Paramètres

batch

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

Fonction qui prend un OneNote.RequestContext et retourne une promesse (généralement, juste le résultat de « context.sync() »). Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

Retours

Promise<T>