OneNote.TableCell class

Paquete:

onenote

Representa una celda en una tabla de OneNote.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

cellIndex	Obtiene el índice de la celda de la fila.
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 de la celda.
paragraphs	Obtiene la colección de objetos Paragraph en el objeto TableCell.
parentRow	Obtiene la fila primaria de la celda.
rowIndex	Obtiene el índice de fila de la celda en la tabla.
shadingColor	Obtiene y establece el color de sombreado de la celda.

Métodos

appendHtml(html)	Agrega el HTML especificado en la parte inferior de TableCell.
appendImage(base64EncodedImage, width, height)	Agrega la imagen especificada a la celda de la tabla.
appendRichText(paragraphText)	Agrega el texto especificado a la celda de la tabla.
appendTable(rowCount, columnCount, values)	Agrega una tabla con el número especificado de filas y columnas a la celda de la tabla.
clear()	Borra el contenido de la celda.
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.
set(properties, options)	Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
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.TableCell es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.TableCellData) 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

cellIndex

Obtiene el índice de la celda de la fila.

readonly cellIndex: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

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 de la celda.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

paragraphs

Obtiene la colección de objetos Paragraph en el objeto TableCell.

readonly paragraphs: OneNote.ParagraphCollection;

Valor de propiedad

OneNote.ParagraphCollection

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

parentRow

Obtiene la fila primaria de la celda.

readonly parentRow: OneNote.TableRow;

Valor de propiedad

OneNote.TableRow

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

rowIndex

Obtiene el índice de fila de la celda en la tabla.

readonly rowIndex: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

shadingColor

Obtiene y establece el color de sombreado de la celda.

shadingColor: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

appendHtml(html)

Agrega el HTML especificado en la parte inferior de TableCell.

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) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    
    const paragraphs = outline.paragraphs;
    
    // For each table, get a table cell at row one and column two and add "Hello".
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            cell.appendHtml("<p>Hello</p>");
        }
    }
    await context.sync();
});

appendImage(base64EncodedImage, width, height)

Agrega la imagen especificada a la celda de la tabla.

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 a la celda de la tabla.

appendRichText(paragraphText: string): OneNote.RichText;

Parámetros

paragraphText

string

Cadena HTML que se anexará.

Devoluciones

OneNote.RichText

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Ejemplos

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    const appendedRichText = null;
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const paragraphs = outline.paragraphs;
    
    // For each table, get a table cell at row one and column two and add "Hello".
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            appendedRichText = cell.appendRichText("Hello");
        }
    }
    await context.sync();
});

appendTable(rowCount, columnCount, values)

Agrega una tabla con el número especificado de filas y columnas a la celda de la tabla.

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 ]

clear()

Borra el contenido de la celda.

clear(): void;

Devoluciones

void

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.TableCellLoadOptions): OneNote.TableCell;

Parámetros

options

OneNote.Interfaces.TableCellLoadOptions

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

Devoluciones

OneNote.TableCell

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

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

Ejemplos

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    const paragraphs = outline.paragraphs;
    
    // For each table, get a table cell at row one and column two.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            
            // Queue a command to load the table cell.
            context.load(cell);
            await context.sync();

            console.log("Cell Id: " + cell.id);
            console.log("Cell Index: " + cell.cellIndex);
            console.log("Cell's Row Index: " + cell.rowIndex);
        }
    }
    await context.sync();
});

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

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

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

OneNote.Interfaces.TableCellUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options

OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: OneNote.TableCell): void;

Parámetros

properties

OneNote.TableCell

Devoluciones

void

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

toJSON(): OneNote.Interfaces.TableCellData;

Devoluciones

OneNote.Interfaces.TableCellData

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

Devoluciones

OneNote.TableCell

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

Devoluciones

OneNote.TableCell