Excel.TableCollection class
Représente une collection de tous les tableaux qui font partie du classeur ou de la feuille de calcul, en fonction de la méthode d’appel.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| count | Renvoie le nombre de tableaux dans le classeur. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(address, has |
Crée une table. L’objet de plage ou l’adresse source détermine la feuille de calcul sous laquelle la table sera ajoutée. Si la table ne peut pas être ajoutée (par exemple, parce que l’adresse n’est pas valide ou que la table chevauche une autre table), une erreur est générée. |
| get |
Obtient le nombre de tableaux de la collection. |
| get |
Obtient un tableau à l’aide de son nom ou de son ID. |
| get |
Obtient un tableau en fonction de sa position dans la collection. |
| get |
Obtient un tableau à l’aide de son nom ou de son ID. Si la table n’existe pas, cette méthode retourne un objet avec sa |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Événements
| on |
Se produit lorsqu’une nouvelle table est ajoutée dans un classeur. |
| on |
Se produit lorsque les données changent sur une table d’un classeur ou d’une feuille de calcul. |
| on |
Se produit lorsque le tableau spécifié est supprimé dans un classeur. |
Détails de la propriété
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
count
Renvoie le nombre de tableaux dans le classeur.
readonly count: number;Valeur de propriété
number
Remarques
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.Table[];Valeur de propriété
Détails de la méthode
add(address, hasHeaders)
Crée une table. L’objet de plage ou l’adresse source détermine la feuille de calcul sous laquelle la table sera ajoutée. Si la table ne peut pas être ajoutée (par exemple, parce que l’adresse n’est pas valide ou que la table chevauche une autre table), une erreur est générée.
add(address: Range | string, hasHeaders: boolean): Excel.Table;Paramètres
- address
-
Excel.Range | string
Objet Range , adresse de chaîne ou nom de la plage représentant la source de données. Si l’adresse ne contient pas de nom de feuille, la feuille ouverte est utilisée. [Ensemble d’API : ExcelApi 1.1 / 1.3. Avant ExcelApi 1.3, ce paramètre doit être une chaîne. À compter de l’Api Excel 1.3, ce paramètre peut être un objet Range ou une chaîne.]
- hasHeaders
-
boolean
Valeur booléenne qui indique si les données importées ont des étiquettes de colonne. Si la source ne contient pas d’en-têtes (par exemple, lorsque cette propriété a la falsevaleur ), Excel génère automatiquement un en-tête et déplace les données d’une ligne vers le bas.
Retours
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Exemples
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()
Obtient le nombre de tableaux de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
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
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Exemples
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)
Obtient un tableau en fonction de sa position dans la collection.
getItemAt(index: number): Excel.Table;Paramètres
- index
-
number
Valeur d’indice de l’objet à récupérer. Avec indice zéro.
Retours
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Exemples
await Excel.run(async (context) => {
const table = context.workbook.tables.getItemAt(0);
table.load('name');
await context.sync();
console.log(table.name);
});
getItemOrNullObject(key)
Obtient un tableau à l’aide de son nom ou de son ID. Si la table n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getItemOrNullObject(key: string): Excel.Table;Paramètres
- key
-
string
Nom ou ID du tableau à récupérer.
Retours
Remarques
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.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableCollection;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
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.TableCollection;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
Exemples
// 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)
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.TableCollection;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 propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.TableCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.TableCollectionData;Retours
Détails de l'événement
onAdded
Se produit lorsqu’une nouvelle table est ajoutée dans un classeur.
readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;Type d'événement
Remarques
onChanged
Se produit lorsque les données changent sur une table d’un classeur ou d’une feuille de calcul.
readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;Type d'événement
Remarques
[ Ensemble d’API : ExcelApi 1.7 ]
Exemples
// 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 produit lorsque le tableau spécifié est supprimé dans un classeur.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>;