OneNote.Outline class

Paquete:

onenote

Representa un contenedor para 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.
id	Obtiene el identificador del objeto Outline.
pageContent	Obtiene el objeto PageContent que contiene el objeto Outline. El objeto define la posición del Outline en la página.
paragraphs	Obtiene la colección de objetos Paragraph en el Outline.

Métodos

appendHtml(html)	Agrega el HTML especificado en la parte inferior del Outline.
appendImage(base64EncodedImage, width, height)	Agrega la imagen especificada en la parte inferior del Outline.
appendRichText(paragraphText)	Agrega el texto especificado en la parte inferior del Outline.
appendTable(rowCount, columnCount, values)	Agrega una tabla con el número especificado de filas y columnas en la parte inferior del Outline.
isTitle()	Compruebe si el esquema es de título.
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.Outline es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.OutlineData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
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 obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar 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

id

Obtiene el identificador del objeto Outline.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

pageContent

Obtiene el objeto PageContent que contiene el objeto Outline. El objeto define la posición del Outline en la página.

readonly pageContent: OneNote.PageContent;

Valor de propiedad

OneNote.PageContent

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

paragraphs

Obtiene la colección de objetos Paragraph en el Outline.

readonly paragraphs: OneNote.ParagraphCollection;

Valor de propiedad

OneNote.ParagraphCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

appendHtml(html)

Agrega el HTML especificado en la parte inferior del Outline.

appendHtml(html: string): void;

Parámetros

html

string

Cadena HTML que se anexará. Consulte HTML compatible para la API de JavaScript de complementos de OneNote.

Devoluciones

void

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Get pageContents of the activePage.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline")
    {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendHtml("<p>new paragraph</p>");

        // Run the queued commands.
        await context.sync();
    }
});

appendImage(base64EncodedImage, width, height)

Agrega la imagen especificada en la parte inferior del Outline.

appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;

Parámetros

base64EncodedImage

string

Cadena HTML que se anexará.

width

number

Opcional. Ancho en la unidad de puntos. El valor predeterminado es null, que respeta el ancho de la imagen.

height

number

Opcional. Alto en la unidad de puntos. El valor predeterminado es null, que respeta el alto de la imagen.

Devoluciones

OneNote.Image

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

appendRichText(paragraphText)

Agrega el texto especificado en la parte inferior del Outline.

appendRichText(paragraphText: string): OneNote.RichText;

Parámetros

paragraphText

string

Cadena HTML que se anexará.

Devoluciones

OneNote.RichText

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

appendTable(rowCount, columnCount, values)

Agrega una tabla con el número especificado de filas y columnas en la parte inferior del Outline.

appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Parámetros

rowCount

number

Obligatorio. Número de filas de la tabla.

columnCount

number

Obligatorio. Número de columnas de la tabla.

values

string[][]

Matriz 2D opcional. Si se especifican las cadenas correspondientes en la matriz, se rellenan las celdas.

Devoluciones

OneNote.Table

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Get pageContents of the activePage.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline") {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendTable(2, 2, [["1", "2"],["3", "4"]]);

        // Run the queued commands.
        await context.sync();
    }
});

isTitle()

Compruebe si el esquema es de título.

isTitle(): OfficeExtension.ClientResult<boolean>;

Devoluciones

OfficeExtension.ClientResult<boolean>

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.OutlineLoadOptions): OneNote.Outline;

Parámetros

options

OneNote.Interfaces.OutlineLoadOptions

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

Devoluciones

OneNote.Outline

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

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

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?: {
            select?: string;
            expand?: string;
        }): OneNote.Outline;

Parámetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

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.Outline es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.OutlineData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): OneNote.Interfaces.OutlineData;

Devoluciones

OneNote.Interfaces.OutlineData

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 obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.

track(): OneNote.Outline;

Devoluciones

OneNote.Outline

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

Devoluciones

OneNote.Outline