Excel.TableScopedCollection class

  • Referencia
Paquete:
excel

Representa una colección con ámbito de tablas. Para cada tabla, su esquina superior izquierda se considera su ubicación de anclaje y las tablas se ordenan de arriba a abajo y, a continuación, de izquierda a derecha.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items

Obtiene los elementos secundarios cargados en esta colección.

Métodos

getCount()

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

Obtiene la primera tabla de la colección. Las tablas de la colección se ordenan de arriba a abajo y de izquierda a derecha, de modo que la tabla superior izquierda es la primera tabla de la colección.
getItem(key)

Obtener una tabla por nombre o identificador.
getItemOrNullObject(key)

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

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

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Table[];

Valor de propiedad

Excel.Table[]

Detalles del método

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.9 ]

getFirst()

Obtiene la primera tabla de la colección. Las tablas de la colección se ordenan de arriba a abajo y de izquierda a derecha, de modo que la tabla superior izquierda es la primera tabla de la colección.

getFirst(): Excel.Table;

Devoluciones

Excel.Table

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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.9 ]

getItemOrNullObject(key)

Obtener una tabla por nombre o identificador. Si el objeto de 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.14 ]

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.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection;

Parámetros

options

Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

Excel.TableScopedCollection

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

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

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

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

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

toJSON(): Excel.Interfaces.TableScopedCollectionData;

Devoluciones

Excel.Interfaces.TableScopedCollectionData