Compartir a través de

OneNote.TableRow class

  • Referencia
Paquete:
onenote

Representa una fila de una tabla.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Propiedades

cellCount

Obtiene el número de celdas de la fila.
cells

Obtiene las celdas 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 fila.
parentTable

Obtiene la tabla primaria.
rowIndex

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

Métodos

clear()

Borra el contenido de la fila.
insertRowAsSibling(insertLocation, values)

Inserta una fila antes o después de la fila actual.
insertRowAsSibling(insertLocationString, values)

Inserta una fila antes o después de la fila actual.
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.
setShadingColor(colorCode)

Establece el color de sombreado de todas las celdas de la fila. El código de color que hay que establecer en las celdas.
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.TableRow es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.TableRowData) 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

cellCount

Obtiene el número de celdas de la fila.

readonly cellCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

cells

Obtiene las celdas de la fila.

readonly cells: OneNote.TableCellCollection;

Valor de propiedad

OneNote.TableCellCollection

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

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

parentTable

Obtiene la tabla primaria.

readonly parentTable: OneNote.Table;

Valor de propiedad

OneNote.Table

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

rowIndex

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

readonly rowIndex: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

Detalles del método

clear()

Borra el contenido de la fila.

clear(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

insertRowAsSibling(insertLocation, values)

Inserta una fila antes o después de la fila actual.

insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;

Parámetros

insertLocation
OneNote.InsertLocation

Dónde se deben insertar las filas nuevas con respecto a la fila actual.

values

string[]

Cadenas para insertar en la nueva fila, especificadas como una matriz. No debe tener más celdas que la fila actual. Opcional.

Devoluciones

OneNote.TableRow

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 table rows.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            
            // Queue a command to load table.rows.
            context.load(table, "rows");
            
            // Run the queued commands.
            await context.sync();

            const rows = table.rows;
            rows.items[1].insertRowAsSibling("Before", ["cell0", "cell1"]);
            await context.sync();
        }
    }
});

insertRowAsSibling(insertLocationString, values)

Inserta una fila antes o después de la fila actual.

insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;

Parámetros

insertLocationString

"Before" | "After"

Dónde se deben insertar las filas nuevas con respecto a la fila actual.

values

string[]

Cadenas para insertar en la nueva fila, especificadas como una matriz. No debe tener más celdas que la fila actual. Opcional.

Devoluciones

OneNote.TableRow

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.TableRowLoadOptions): OneNote.TableRow;

Parámetros

options
OneNote.Interfaces.TableRowLoadOptions

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

Devoluciones

OneNote.TableRow

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

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

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 table rows.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            
            // Queue a command to load table.rows.
            context.load(table, "rows");
            await context.sync();

            const rows = table.rows;
            
            // For each table row, log cell count and row index.
            for (let i = 0; i < rows.items.length; i++) {
                console.log("Row " + i + " Id: " + rows.items[i].id);
                console.log("Row " + i + " Cell Count: " + rows.items[i].cellCount);
                console.log("Row " + i + " Row Index: " + rows.items[i].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.TableRow;

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

setShadingColor(colorCode)

Establece el color de sombreado de todas las celdas de la fila. El código de color que hay que establecer en las celdas.

setShadingColor(colorCode: string): void;

Parámetros

colorCode

string

Devoluciones

void

Comentarios

[ Conjunto de API: OneNoteApi 1.1 ]

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

toJSON(): OneNote.Interfaces.TableRowData;

Devoluciones

OneNote.Interfaces.TableRowData

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

Devoluciones

OneNote.TableRow

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

Devoluciones

OneNote.TableRow