OneNote.ParagraphCollection class

Paquete:

onenote

Representa una colección de objetos Paragraph.

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 párrafos de una página. Solo lectura.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

getItem(index)	Obtiene un objeto Paragraph por su identificador o por su índice en la colección. Solo lectura.
getItemAt(index)	Obtiene un párrafo según 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.ParagraphCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.ParagraphCollectionData) 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 párrafos de una 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.Paragraph[];

Valor de propiedad

OneNote.Paragraph[]

Detalles del método

getItem(index)

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

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

Parámetros

index

number | string

El id. del objeto Paragraph, o bien la ubicación del índice del bloc de notas en la colección.

Devoluciones

OneNote.Paragraph

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

getItemAt(index)

Obtiene un párrafo según su posición en la colección.

getItemAt(index: number): OneNote.Paragraph;

Parámetros

index

number

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

Devoluciones

OneNote.Paragraph

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

await OneNote.run(async (context) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page, and then get its Outline's first paragraph.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;

    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type properties of this paragraph.
    firstParagraph.load("id,type");


    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    // Write text from paragraph to console.
    console.log(
        "First Paragraph found with id : " + 
        firstParagraph.id + " and type " + firstParagraph.type);
});

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.ParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.ParagraphCollection;

Parámetros

options

OneNote.Interfaces.ParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions

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

Devoluciones

OneNote.ParagraphCollection

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.ParagraphCollection;

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.ParagraphCollection

Ejemplos

await OneNote.run(async (context) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page, and then get its Outline's first paragraph.
    const pageContent = pageContents.getItem(0);
    const paragraphs = pageContent.outline.paragraphs;
    
    // Queue a command to load the id and type of each paragraph.
    paragraphs.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    const firstParagraph = paragraphs.items[0];
    // Write text from first paragraph to console.
    console.log(
        "First Paragraph found with id : " + 
        firstParagraph.id + " and type " + firstParagraph.type);
});

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.ParagraphCollection;

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.ParagraphCollection

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.ParagraphCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.ParagraphCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): OneNote.Interfaces.ParagraphCollectionData;

Devoluciones

OneNote.Interfaces.ParagraphCollectionData

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.ParagraphCollection;

Devoluciones

OneNote.ParagraphCollection

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.ParagraphCollection;

Devoluciones

OneNote.ParagraphCollection