Excel.TableScopedCollection class

  • Référence
Paquet:
excel

Représente une collection étendue de tableaux. Pour chaque tableau, son coin supérieur gauche est considéré comme son emplacement d’ancrage, et les tableaux sont triés de haut en bas, puis de gauche à droite.

Extends
OfficeExtension.ClientObject

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

Propriétés

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.
items

Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

getCount()

Obtient le nombre de tableaux de la collection.
getFirst()

Obtient le premier tableau de cette collection. Les tableaux de la collection sont triés de haut en bas et de gauche à droite, de sorte que le tableau supérieur gauche est le premier tableau de la collection.
getItem(key)

Obtient un tableau à l’aide de son nom ou de son ID.
getItemOrNullObject(key)

Obtient un tableau à l’aide de son nom ou de son ID. Si l’objet table n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.
load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que Excel.TableScopedCollection l’objet d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.TableScopedCollectionData) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Table[];

Valeur de propriété

Excel.Table[]

Détails de la méthode

getCount()

Obtient le nombre de tableaux de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getFirst()

Obtient le premier tableau de cette collection. Les tableaux de la collection sont triés de haut en bas et de gauche à droite, de sorte que le tableau supérieur gauche est le premier tableau de la collection.

getFirst(): Excel.Table;

Retours

Excel.Table

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getItem(key)

Obtient un tableau à l’aide de son nom ou de son ID.

getItem(key: string): Excel.Table;

Paramètres

key

string

Nom ou ID du tableau à récupérer.

Retours

Excel.Table

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

getItemOrNullObject(key)

Obtient un tableau à l’aide de son nom ou de son ID. Si l’objet table n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getItemOrNullObject(key: string): Excel.Table;

Paramètres

key

string

Nom ou ID du tableau à récupérer.

Retours

Excel.Table

Remarques

[Ensemble d’API : ExcelApi 1.14 ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableScopedCollection;

Paramètres

options

Excel.Interfaces.TableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fournit des options pour lesquelles les propriétés de l’objet à charger.

Retours

Excel.TableScopedCollection

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.TableScopedCollection;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Excel.TableScopedCollection

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableScopedCollection;

Paramètres

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

Excel.TableScopedCollection

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que Excel.TableScopedCollection l’objet d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.TableScopedCollectionData) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.TableScopedCollectionData;

Retours

Excel.Interfaces.TableScopedCollectionData