Excel.TableColumn class
Representa una columna en una tabla.
- Extends
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. |
| filter | Recupera el filtro aplicado a la columna. |
| id | Devuelve una clave única que identifica la columna de la tabla. |
| index | Devuelve el número de índice de la columna dentro de la colección de columnas de la tabla. Indizado con cero. |
| name | Especifica el nombre de la columna de tabla. |
| values | Representa los valores sin formato del rango especificado. Los datos devueltos podrían ser una cadena, un número o un valor booleano. Las celdas que contienen un error devolverán la cadena de error. Si el valor devuelto comienza con un signo más ("+"), menos ("-") o un signo igual ("="), Excel interpreta este valor como una fórmula. |
| values |
Representación JSON de los valores de las celdas de esta columna de tabla. A diferencia de |
| values |
Representación JSON de los valores de las celdas de esta columna de tabla. A diferencia de |
Métodos
| delete() | Elimina la columna de la tabla. |
| get |
Obtiene el objeto de rango asociado al cuerpo de datos de la columna. |
| get |
Obtiene el objeto de rango asociado a la fila de encabezado de la columna. |
| get |
Obtiene el objeto de rango asociado a toda la columna. |
| get |
Obtiene el objeto de rango asociado a la fila de totales de la columna. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| 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 |
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
filter
Recupera el filtro aplicado a la columna.
readonly filter: Excel.Filter;Valor de propiedad
Comentarios
id
Devuelve una clave única que identifica la columna de la tabla.
readonly id: number;Valor de propiedad
number
Comentarios
index
Devuelve el número de índice de la columna dentro de la colección de columnas de la tabla. Indizado con cero.
readonly index: number;Valor de propiedad
number
Comentarios
name
Especifica el nombre de la columna de tabla.
name: string;Valor de propiedad
string
Comentarios
[ Conjunto de API: ExcelApi 1.1 para obtener el nombre; 1.4 para establecerlo. ]
values
Representa los valores sin formato del rango especificado. Los datos devueltos podrían ser una cadena, un número o un valor booleano. Las celdas que contienen un error devolverán la cadena de error. Si el valor devuelto comienza con un signo más ("+"), menos ("-") o un signo igual ("="), Excel interpreta este valor como una fórmula.
values: any[][];Valor de propiedad
any[][]
Comentarios
valuesAsJson
Representación JSON de los valores de las celdas de esta columna de tabla. A diferencia de TableColumn.values, TableColumn.valuesAsJson admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional en-US. Para recuperar datos en la configuración regional de visualización del usuario, use TableColumn.valuesAsJsonLocal.
valuesAsJson: CellValue[][];Valor de propiedad
Excel.CellValue[][]
Comentarios
valuesAsJsonLocal
Representación JSON de los valores de las celdas de esta columna de tabla. A diferencia de TableColumn.values, TableColumn.valuesAsJsonLocal admite todos los tipos de datos que pueden estar en una celda. Entre los ejemplos se incluyen valores de número con formato e imágenes web, además de los valores booleanos, numéricos y de cadena estándar. Los datos devueltos desde esta API siempre se alinean con la configuración regional de visualización del usuario. Para recuperar datos independientes de la configuración regional, use TableColumn.valuesAsJson.
valuesAsJsonLocal: CellValue[][];Valor de propiedad
Excel.CellValue[][]
Comentarios
Detalles del método
delete()
Elimina la columna de la tabla.
delete(): void;Devoluciones
void
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
column.delete();
await context.sync();
});
getDataBodyRange()
Obtiene el objeto de rango asociado al cuerpo de datos de la columna.
getDataBodyRange(): Excel.Range;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const dataBodyRange = column.getDataBodyRange();
dataBodyRange.load('address');
await context.sync();
console.log(dataBodyRange.address);
});
getHeaderRowRange()
Obtiene el objeto de rango asociado a la fila de encabezado de la columna.
getHeaderRowRange(): Excel.Range;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const headerRowRange = columns.getHeaderRowRange();
headerRowRange.load('address');
await context.sync();
console.log(headerRowRange.address);
});
getRange()
Obtiene el objeto de rango asociado a toda la columna.
getRange(): Excel.Range;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const columnRange = columns.getRange();
columnRange.load('address');
await context.sync();
console.log(columnRange.address);
});
getTotalRowRange()
Obtiene el objeto de rango asociado a la fila de totales de la columna.
getTotalRowRange(): Excel.Range;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Ejemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
const totalRowRange = columns.getTotalRowRange();
totalRowRange.load('address');
await context.sync();
console.log(totalRowRange.address);
});
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.TableColumnLoadOptions): Excel.TableColumn;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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.TableColumn;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
Ejemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const column = context.workbook.tables.getItem(tableName).columns.getItem(0);
column.load('index');
await context.sync();
console.log(column.index);
});
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;
}): Excel.TableColumn;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
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.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.TableColumnUpdateData
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: Excel.TableColumn): void;Parámetros
- properties
- Excel.TableColumn
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 Excel.TableColumn es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TableColumnData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.TableColumnData;