Compartir a través de


onenote package

Clases

OneNote.Application

Representa el objeto de nivel superior que contiene todos los objetos de OneNote a los que se pueden hacer referencia globalmente, como blocs de notas, el bloc de notas activo y la sección activa.

OneNote.FloatingInk

Representa un grupo de trazos de tinta.

OneNote.Image

Representa a Image. Image puede ser un elemento secundario directo de un objeto PageContent o de un objeto Paragraph.

OneNote.InkAnalysis

Representa datos de análisis de tinta para un determinado conjunto de trazos de tinta.

OneNote.InkAnalysisLine

Representa los datos de análisis de tinta para una línea de texto identificada formada por trazos de tinta.

OneNote.InkAnalysisLineCollection

Representa una colección de objetos InkAnalysisLine.

OneNote.InkAnalysisParagraph

Representa los datos de análisis de tinta para un párrafo identificado formado por trazos de tinta.

OneNote.InkAnalysisParagraphCollection

Representa una colección de objetos InkAnalysisParagraph.

OneNote.InkAnalysisWord

Representa los datos de análisis de tinta para una palabra identificada formada por trazos de tinta.

OneNote.InkAnalysisWordCollection

Representa una colección de objetos InkAnalysisWord.

OneNote.InkStroke

Representa un solo trazo de tinta.

OneNote.InkStrokeCollection

Representa una colección de objetos InkStroke.

OneNote.InkWord

El contenedor de la tinta de una palabra de un párrafo.

OneNote.InkWordCollection

Representa una colección de objetos InkWord.

OneNote.Notebook

Representa un bloc de notas de OneNote. Los blocs de notas contienen grupos de secciones y secciones.

OneNote.NotebookCollection

Representa una colección de blocs de notas.

OneNote.NoteTag

Contenedor de notetag en un párrafo.

OneNote.Outline

Representa un contenedor para objetos Paragraph.

OneNote.Page

Representa una página de OneNote.

OneNote.PageCollection

Representa una colección de páginas.

OneNote.PageContent

Representa una región de nivel superior en una página que contiene tipos de contenido de nivel superior, como Outline o Image. Un objeto PageContent se puede asignar a una posición XY.

OneNote.PageContentCollection

Representa el contenido de una página, como una colección de objetos PageContent.

OneNote.Paragraph

Contenedor para el contenido visible en una página. Un Paragraph puede contener cualquier tipo de ParagraphType de contenido.

OneNote.ParagraphCollection

Representa una colección de objetos Paragraph.

OneNote.Point

Representa un único punto de trazo de lápiz

OneNote.PointCollection

Representa una colección de objetos Point.

OneNote.RequestContext
OneNote.RichText

Representa un objeto RichText en un Paragraph.

OneNote.Section

Representa una sección de OneNote. Las secciones pueden contener páginas.

OneNote.SectionCollection

Representa una colección de secciones.

OneNote.SectionGroup

Representa un grupo de secciones de OneNote. Los grupos de secciones pueden contener secciones y otros grupos de secciones.

OneNote.SectionGroupCollection

Representa una colección de grupos de secciones.

OneNote.Table

Representa una tabla en una página de OneNote.

OneNote.TableCell

Representa una celda en una tabla de OneNote.

OneNote.TableCellCollection

Contiene una colección de objetos TableCell.

OneNote.TableRow

Representa una fila de una tabla.

OneNote.TableRowCollection

Contiene una colección de objetos TableRow.

Interfaces

OneNote.ImageOcrData

Representa los datos obtenidos por OCR (reconocimiento óptico de caracteres) de una imagen.

OneNote.InkStrokePointer

Referencia débil a un objeto de trazo de lápiz y su elemento primario de contenido.

OneNote.Interfaces.ApplicationData

Interfaz que describe los datos devueltos mediante una llamada a application.toJSON().

OneNote.Interfaces.ApplicationLoadOptions

Representa el objeto de nivel superior que contiene todos los objetos de OneNote a los que se pueden hacer referencia globalmente, como blocs de notas, el bloc de notas activo y la sección activa.

OneNote.Interfaces.ApplicationUpdateData

Interfaz para actualizar datos en el objeto Application, para su uso en application.set({ ... }).

OneNote.Interfaces.CollectionLoadOptions

Proporciona formas de cargar las propiedades de solo un subconjunto de miembros de una colección.

OneNote.Interfaces.FloatingInkData

Interfaz que describe los datos devueltos mediante una llamada a floatingInk.toJSON().

OneNote.Interfaces.FloatingInkLoadOptions

Representa un grupo de trazos de tinta.

OneNote.Interfaces.ImageData

Interfaz que describe los datos devueltos mediante una llamada a image.toJSON().

OneNote.Interfaces.ImageLoadOptions

Representa a Image. Image puede ser un elemento secundario directo de un objeto PageContent o de un objeto Paragraph.

OneNote.Interfaces.ImageUpdateData

Interfaz para actualizar datos en el objeto Image, para su uso en image.set({ ... }).

OneNote.Interfaces.InkAnalysisData

Interfaz que describe los datos devueltos mediante una llamada a inkAnalysis.toJSON().

OneNote.Interfaces.InkAnalysisLineCollectionData

Interfaz que describe los datos devueltos mediante una llamada a inkAnalysisLineCollection.toJSON().

OneNote.Interfaces.InkAnalysisLineCollectionLoadOptions

Representa una colección de objetos InkAnalysisLine.

OneNote.Interfaces.InkAnalysisLineCollectionUpdateData

Interfaz para actualizar datos en el objeto InkAnalysisLineCollection, para su uso en inkAnalysisLineCollection.set({ ... }).

OneNote.Interfaces.InkAnalysisLineData

Interfaz que describe los datos devueltos mediante una llamada a inkAnalysisLine.toJSON().

OneNote.Interfaces.InkAnalysisLineLoadOptions

Representa los datos de análisis de tinta para una línea de texto identificada formada por trazos de tinta.

OneNote.Interfaces.InkAnalysisLineUpdateData

Interfaz para actualizar datos en el objeto InkAnalysisLine, para su uso en inkAnalysisLine.set({ ... }).

OneNote.Interfaces.InkAnalysisLoadOptions

Representa datos de análisis de tinta para un determinado conjunto de trazos de tinta.

OneNote.Interfaces.InkAnalysisParagraphCollectionData

Interfaz que describe los datos devueltos mediante una llamada a inkAnalysisParagraphCollection.toJSON().

OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions

Representa una colección de objetos InkAnalysisParagraph.

OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData

Interfaz para actualizar datos en el objeto InkAnalysisParagraphCollection, para su uso en inkAnalysisParagraphCollection.set({ ... }).

OneNote.Interfaces.InkAnalysisParagraphData

Interfaz que describe los datos devueltos mediante una llamada a inkAnalysisParagraph.toJSON().

OneNote.Interfaces.InkAnalysisParagraphLoadOptions

Representa los datos de análisis de tinta para un párrafo identificado formado por trazos de tinta.

OneNote.Interfaces.InkAnalysisParagraphUpdateData

Interfaz para actualizar datos en el objeto InkAnalysisParagraph, para su uso en inkAnalysisParagraph.set({ ... }).

OneNote.Interfaces.InkAnalysisUpdateData

Interfaz para actualizar datos en el objeto InkAnalysis, para su uso en inkAnalysis.set({ ... }).

OneNote.Interfaces.InkAnalysisWordCollectionData

Interfaz que describe los datos devueltos mediante una llamada a inkAnalysisWordCollection.toJSON().

OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions

Representa una colección de objetos InkAnalysisWord.

OneNote.Interfaces.InkAnalysisWordCollectionUpdateData

Interfaz para actualizar datos en el objeto InkAnalysisWordCollection, para su uso en inkAnalysisWordCollection.set({ ... }).

OneNote.Interfaces.InkAnalysisWordData

Interfaz que describe los datos devueltos mediante una llamada a inkAnalysisWord.toJSON().

OneNote.Interfaces.InkAnalysisWordLoadOptions

Representa los datos de análisis de tinta para una palabra identificada formada por trazos de tinta.

OneNote.Interfaces.InkAnalysisWordUpdateData

Interfaz para actualizar datos en el objeto InkAnalysisWord, para su uso en inkAnalysisWord.set({ ... }).

OneNote.Interfaces.InkStrokeCollectionData

Interfaz que describe los datos devueltos mediante una llamada a inkStrokeCollection.toJSON().

OneNote.Interfaces.InkStrokeCollectionLoadOptions

Representa una colección de objetos InkStroke.

OneNote.Interfaces.InkStrokeCollectionUpdateData

Interfaz para actualizar datos en el objeto InkStrokeCollection, para su uso en inkStrokeCollection.set({ ... }).

OneNote.Interfaces.InkStrokeData

Interfaz que describe los datos devueltos mediante una llamada a inkStroke.toJSON().

OneNote.Interfaces.InkStrokeLoadOptions

Representa un solo trazo de tinta.

OneNote.Interfaces.InkWordCollectionData

Interfaz que describe los datos devueltos mediante una llamada a inkWordCollection.toJSON().

OneNote.Interfaces.InkWordCollectionLoadOptions

Representa una colección de objetos InkWord.

OneNote.Interfaces.InkWordCollectionUpdateData

Interfaz para actualizar datos en el objeto InkWordCollection, para su uso en inkWordCollection.set({ ... }).

OneNote.Interfaces.InkWordData

Interfaz que describe los datos devueltos mediante una llamada a inkWord.toJSON().

OneNote.Interfaces.InkWordLoadOptions

El contenedor de la tinta de una palabra de un párrafo.

OneNote.Interfaces.NotebookCollectionData

Interfaz que describe los datos devueltos mediante una llamada a notebookCollection.toJSON().

OneNote.Interfaces.NotebookCollectionLoadOptions

Representa una colección de blocs de notas.

OneNote.Interfaces.NotebookCollectionUpdateData

Interfaz para actualizar datos en el objeto NotebookCollection, para su uso en notebookCollection.set({ ... }).

OneNote.Interfaces.NotebookData

Interfaz que describe los datos devueltos mediante una llamada a notebook.toJSON().

OneNote.Interfaces.NotebookLoadOptions

Representa un bloc de notas de OneNote. Los blocs de notas contienen grupos de secciones y secciones.

OneNote.Interfaces.NoteTagData

Interfaz que describe los datos devueltos mediante una llamada a noteTag.toJSON().

OneNote.Interfaces.NoteTagLoadOptions

Contenedor de notetag en un párrafo.

OneNote.Interfaces.OutlineData

Interfaz que describe los datos devueltos mediante una llamada a outline.toJSON().

OneNote.Interfaces.OutlineLoadOptions

Representa un contenedor para objetos Paragraph.

OneNote.Interfaces.PageCollectionData

Interfaz que describe los datos devueltos mediante una llamada a pageCollection.toJSON().

OneNote.Interfaces.PageCollectionLoadOptions

Representa una colección de páginas.

OneNote.Interfaces.PageCollectionUpdateData

Interfaz para actualizar datos en el objeto PageCollection, para su uso en pageCollection.set({ ... }).

OneNote.Interfaces.PageContentCollectionData

Interfaz que describe los datos devueltos mediante una llamada a pageContentCollection.toJSON().

OneNote.Interfaces.PageContentCollectionLoadOptions

Representa el contenido de una página, como una colección de objetos PageContent.

OneNote.Interfaces.PageContentCollectionUpdateData

Interfaz para actualizar datos en el objeto PageContentCollection, para su uso en pageContentCollection.set({ ... }).

OneNote.Interfaces.PageContentData

Interfaz que describe los datos devueltos mediante una llamada a pageContent.toJSON().

OneNote.Interfaces.PageContentLoadOptions

Representa una región de nivel superior en una página que contiene tipos de contenido de nivel superior, como Outline o Image. Un objeto PageContent se puede asignar a una posición XY.

OneNote.Interfaces.PageContentUpdateData

Interfaz para actualizar datos en el objeto PageContent, para su uso en pageContent.set({ ... }).

OneNote.Interfaces.PageData

Interfaz que describe los datos devueltos mediante una llamada a page.toJSON().

OneNote.Interfaces.PageLoadOptions

Representa una página de OneNote.

OneNote.Interfaces.PageUpdateData

Interfaz para actualizar datos en el objeto Page, para su uso en page.set({ ... }).

OneNote.Interfaces.ParagraphCollectionData

Interfaz que describe los datos devueltos mediante una llamada a paragraphCollection.toJSON().

OneNote.Interfaces.ParagraphCollectionLoadOptions

Representa una colección de objetos Paragraph.

OneNote.Interfaces.ParagraphCollectionUpdateData

Interfaz para actualizar datos en el objeto ParagraphCollection, para su uso en paragraphCollection.set({ ... }).

OneNote.Interfaces.ParagraphData

Interfaz que describe los datos devueltos mediante una llamada a paragraph.toJSON().

OneNote.Interfaces.ParagraphLoadOptions

Contenedor para el contenido visible en una página. Un Paragraph puede contener cualquier tipo de ParagraphType de contenido.

OneNote.Interfaces.ParagraphUpdateData

Interfaz para actualizar datos en el objeto Paragraph, para su uso en paragraph.set({ ... }).

OneNote.Interfaces.PointCollectionData

Interfaz que describe los datos devueltos mediante una llamada a pointCollection.toJSON().

OneNote.Interfaces.PointCollectionLoadOptions

Representa una colección de objetos Point.

OneNote.Interfaces.PointCollectionUpdateData

Interfaz para actualizar datos en el objeto PointCollection, para su uso en pointCollection.set({ ... }).

OneNote.Interfaces.PointData

Interfaz que describe los datos devueltos mediante una llamada a point.toJSON().

OneNote.Interfaces.PointLoadOptions

Representa un único punto de trazo de lápiz

OneNote.Interfaces.RichTextData

Interfaz que describe los datos devueltos mediante una llamada a richText.toJSON().

OneNote.Interfaces.RichTextLoadOptions

Representa un objeto RichText en un Paragraph.

OneNote.Interfaces.SectionCollectionData

Interfaz que describe los datos devueltos mediante una llamada a sectionCollection.toJSON().

OneNote.Interfaces.SectionCollectionLoadOptions

Representa una colección de secciones.

OneNote.Interfaces.SectionCollectionUpdateData

Interfaz para actualizar datos en el objeto SectionCollection, para su uso en sectionCollection.set({ ... }).

OneNote.Interfaces.SectionData

Interfaz que describe los datos devueltos mediante una llamada a section.toJSON().

OneNote.Interfaces.SectionGroupCollectionData

Interfaz que describe los datos devueltos mediante una llamada a sectionGroupCollection.toJSON().

OneNote.Interfaces.SectionGroupCollectionLoadOptions

Representa una colección de grupos de secciones.

OneNote.Interfaces.SectionGroupCollectionUpdateData

Interfaz para actualizar datos en el objeto SectionGroupCollection, para su uso en sectionGroupCollection.set({ ... }).

OneNote.Interfaces.SectionGroupData

Interfaz que describe los datos devueltos mediante una llamada a sectionGroup.toJSON().

OneNote.Interfaces.SectionGroupLoadOptions

Representa un grupo de secciones de OneNote. Los grupos de secciones pueden contener secciones y otros grupos de secciones.

OneNote.Interfaces.SectionLoadOptions

Representa una sección de OneNote. Las secciones pueden contener páginas.

OneNote.Interfaces.TableCellCollectionData

Interfaz que describe los datos devueltos mediante una llamada a tableCellCollection.toJSON().

OneNote.Interfaces.TableCellCollectionLoadOptions

Contiene una colección de objetos TableCell.

OneNote.Interfaces.TableCellCollectionUpdateData

Interfaz para actualizar datos en el objeto TableCellCollection, para su uso en tableCellCollection.set({ ... }).

OneNote.Interfaces.TableCellData

Interfaz que describe los datos devueltos mediante una llamada a tableCell.toJSON().

OneNote.Interfaces.TableCellLoadOptions

Representa una celda en una tabla de OneNote.

OneNote.Interfaces.TableCellUpdateData

Interfaz para actualizar datos en el objeto TableCell, para su uso en tableCell.set({ ... }).

OneNote.Interfaces.TableData

Interfaz que describe los datos devueltos mediante una llamada a table.toJSON().

OneNote.Interfaces.TableLoadOptions

Representa una tabla en una página de OneNote.

OneNote.Interfaces.TableRowCollectionData

Interfaz que describe los datos devueltos mediante una llamada a tableRowCollection.toJSON().

OneNote.Interfaces.TableRowCollectionLoadOptions

Contiene una colección de objetos TableRow.

OneNote.Interfaces.TableRowCollectionUpdateData

Interfaz para actualizar datos en el objeto TableRowCollection, para su uso en tableRowCollection.set({ ... }).

OneNote.Interfaces.TableRowData

Interfaz que describe los datos devueltos mediante una llamada a tableRow.toJSON().

OneNote.Interfaces.TableRowLoadOptions

Representa una fila de una tabla.

OneNote.Interfaces.TableUpdateData

Interfaz para actualizar datos en el objeto Table, para su uso en table.set({ ... }).

OneNote.ParagraphInfo

Enumera la información del párrafo.

Enumeraciones

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

Funciones

OneNote.run(batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de OneNote mediante un nuevo contexto de solicitud. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

OneNote.run(object, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de OneNote mediante el contexto de solicitud de un objeto de API creado anteriormente.

OneNote.run(objects, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de OneNote mediante el contexto de solicitud de objetos de API creados anteriormente.

Detalles de la función

OneNote.run(batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de OneNote mediante un nuevo contexto de solicitud. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

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

Parámetros

batch

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

Función que toma oneNote.RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). El parámetro de contexto facilita las solicitudes a la aplicación OneNote. Dado que el complemento de Office y la aplicación OneNote se ejecutan en dos procesos diferentes, el contexto de solicitud es necesario para obtener acceso al modelo de objetos de OneNote desde el complemento.

Devoluciones

Promise<T>

OneNote.run(object, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de OneNote mediante el contexto de solicitud de un objeto de API creado anteriormente.

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

Parámetros

object
OfficeExtension.ClientObject

Objeto de API creado anteriormente. El lote usará el mismo contexto de solicitud que el objeto pasado, lo que significa que cualquier cambio aplicado al objeto será recogido por "context.sync()".

batch

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

Función que toma oneNote.RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

Devoluciones

Promise<T>

OneNote.run(objects, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de OneNote mediante el contexto de solicitud de objetos de API creados anteriormente.

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

Parámetros

batch

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

Función que toma oneNote.RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

Devoluciones

Promise<T>