Excel.TableCollection class

  • Referencia
Paquete:
excel

Representa una colección de todas las tablas que forman parte del libro o la hoja de cálculo, dependiendo de cómo se haya alcanzado.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 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 tablas del libro.
items

Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(address, hasHeaders)

Crear una tabla. El objeto de rango o la dirección de origen determinan la hoja de cálculo a la que se agregará la tabla. Si no se puede agregar la tabla (por ejemplo, porque la dirección no es válida o porque la tabla se superpondría con otra tabla), se producirá un error.
getCount()

Obtiene el número de tablas de la colección.
getItem(key)

Obtener una tabla por nombre o identificador.
getItemAt(index)

Obtiene una tabla basada en su posición en la colección.
getItemOrNullObject(key)

Obtener una tabla por nombre o identificador. Si la tabla no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
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 Excel.TableCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Eventos

onAdded

Se produce cuando se agrega una nueva tabla en un libro.
onChanged

Se produce cuando los datos cambian en cualquier tabla de un libro o una hoja de cálculo.
onDeleted

Se produce cuando se elimina la tabla especificada en un libro.

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

Excel.RequestContext

count

Devuelve el número de tablas del libro.

readonly count: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Table[];

Valor de propiedad

Excel.Table[]

Detalles del método

add(address, hasHeaders)

Crear una tabla. El objeto de rango o la dirección de origen determinan la hoja de cálculo a la que se agregará la tabla. Si no se puede agregar la tabla (por ejemplo, porque la dirección no es válida o porque la tabla se superpondría con otra tabla), se producirá un error.

add(address: Range | string, hasHeaders: boolean): Excel.Table;

Parámetros

address

Excel.Range | string

Un Range objeto, una dirección de cadena o un nombre del intervalo que representa el origen de datos. Si la dirección no contiene un nombre de hoja, se usa la hoja activa en ese momento. [Conjunto de api: ExcelApi 1.1 /1.3. Antes de ExcelApi 1.3, este parámetro debe ser una cadena. A partir de Excel Api 1.3, este parámetro puede ser un objeto Range o una cadena.]

hasHeaders

boolean

Valor booleano que indica si los datos que se importan tienen etiquetas de columna. Si el origen no contiene encabezados (es decir, cuando esta propiedad se establece en false), Excel generará automáticamente un encabezado y desplazará los datos hacia abajo por una fila.

Devoluciones

Excel.Table

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const table = context.workbook.tables.add('Sheet1!A1:E7', true);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

getCount()

Obtiene el número de tablas de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

getItem(key)

Obtener una tabla por nombre o identificador.

getItem(key: string): Excel.Table;

Parámetros

key

string

Nombre o identificador de la tabla que se va a recuperar.

Devoluciones

Excel.Table

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

getItemAt(index)

Obtiene una tabla basada en su posición en la colección.

getItemAt(index: number): Excel.Table;

Parámetros

index

number

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

Devoluciones

Excel.Table

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const table = context.workbook.tables.getItemAt(0);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

getItemOrNullObject(key)

Obtener una tabla por nombre o identificador. Si la tabla no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(key: string): Excel.Table;

Parámetros

key

string

Nombre o identificador de la tabla que se va a recuperar.

Devoluciones

Excel.Table

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

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?: Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;

Parámetros

options

Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

Excel.TableCollection

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[]): Excel.TableCollection;

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

Excel.TableCollection

Ejemplos

// Get the number of tables.
await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    tables.load('count');
    await context.sync();
    
    console.log(tables.count);
});

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): Excel.TableCollection;

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

Excel.TableCollection

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

toJSON(): Excel.Interfaces.TableCollectionData;

Devoluciones

Excel.Interfaces.TableCollectionData

Detalles del evento

onAdded

Se produce cuando se agrega una nueva tabla en un libro.

readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

onChanged

Se produce cuando los datos cambian en cualquier tabla de un libro o una hoja de cálculo.

readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml

await Excel.run(async (context) => {
    let tables = context.workbook.tables;
    tables.onChanged.add(onChange);

    await context.sync();
    console.log("A handler has been registered for the table collection onChanged event");
});

onDeleted

Se produce cuando se elimina la tabla especificada en un libro.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]