Share via

OneNote.InkAnalysisParagraphCollection class

  • Referencia
Paquete:
onenote

Representa una colección de objetos InkAnalysisParagraph.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
count

Devuelve el número de InkAnalysisParagraphs de la página. Solo lectura.
items

Obtiene los elementos secundarios cargados en esta colección.

Métodos

getItem(index)

Obtiene un objeto InkAnalysisParagraph por su identificador o por su índice en la colección. Solo lectura.
getItemAt(index)

Obtiene un objeto InkAnalysisParagraph en su posición en la colección.
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original OneNote.InkAnalysisParagraphCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.InkAnalysisParagraphCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.
track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe haber agregado el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.
untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

OneNote.RequestContext

count

Devuelve el número de InkAnalysisParagraphs de la página. Solo lectura.

readonly count: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: OneNote.InkAnalysisParagraph[];

Valor de propiedad

OneNote.InkAnalysisParagraph[]

Detalles del método

getItem(index)

Obtiene un objeto InkAnalysisParagraph por su identificador o por su índice en la colección. Solo lectura.

getItem(index: number | string): OneNote.InkAnalysisParagraph;

Parámetros

index

number | string

El identificador del objeto InkAnalysisParagraph, o bien la ubicación del objeto InkAnalysisParagraph en la colección.

Devoluciones

OneNote.InkAnalysisParagraph

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

getItemAt(index)

Obtiene un objeto InkAnalysisParagraph en su posición en la colección.

getItemAt(index: number): OneNote.InkAnalysisParagraph;

Parámetros

index

number

Valor de índice del objeto que se va a recuperar. Indizado con cero.

Devoluciones

OneNote.InkAnalysisParagraph

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.InkAnalysisParagraphCollection;

Parámetros

options

OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

OneNote.InkAnalysisParagraphCollection

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): OneNote.InkAnalysisParagraphCollection;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

OneNote.InkAnalysisParagraphCollection

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisParagraphCollection;

Parámetros

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

OneNote.InkAnalysisParagraphCollection

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original OneNote.InkAnalysisParagraphCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.InkAnalysisParagraphCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData;

Devoluciones

OneNote.Interfaces.InkAnalysisParagraphCollectionData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe haber agregado el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.

track(): OneNote.InkAnalysisParagraphCollection;

Devoluciones

OneNote.InkAnalysisParagraphCollection

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): OneNote.InkAnalysisParagraphCollection;

Devoluciones

OneNote.InkAnalysisParagraphCollection