Excel.TableStyleCollection class
Représente un ensemble de styles de tableau.
- Extends
Remarques
[Jeu d’API : ExcelApi 1.10]
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(name, make |
Crée un espace |
| get |
Obtient le nombre de styles de tableaux de la collection. |
| get |
Obtient le style de table par défaut pour l’étendue de l’objet parent. |
| get |
Gets a by |
| get |
Gets a by |
| 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 |
| set |
Définit le style de table par défaut à utiliser dans l’étendue de l’objet parent. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.TableStyle[];Valeur de propriété
Détails de la méthode
add(name, makeUniqueName)
Crée un espace TableStyle avec le nom spécifié.
add(name: string, makeUniqueName?: boolean): Excel.TableStyle;Paramètres
- name
-
string
Nom unique du nouveau style de tableau. Génère une InvalidArgument erreur si le nom est déjà utilisé.
- makeUniqueName
-
boolean
Facultatif. La valeur par défaut est .false Si true, ajoutera des numéros au nom afin de le rendre unique, si nécessaire.
Retours
Le fichier TableStyle.
Remarques
[Jeu d’API : ExcelApi 1.10]
getCount()
Obtient le nombre de styles de tableaux de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
[Jeu d’API : ExcelApi 1.10]
getDefault()
Obtient le style de table par défaut pour l’étendue de l’objet parent.
getDefault(): Excel.TableStyle;Retours
L’objet TableStyle qui est le style de table par défaut actuel.
Remarques
[Jeu d’API : ExcelApi 1.10]
getItem(name)
Gets a by TableStyle name.
getItem(name: string): Excel.TableStyle;Paramètres
- name
-
string
Nom du style de table à récupérer.
Retours
Objet TableStyle dont le nom correspond à l’entrée.
Remarques
[Jeu d’API : ExcelApi 1.10]
getItemOrNullObject(name)
Gets a by TableStyle name. Si le style de table n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemOrNullObject(name: string): Excel.TableStyle;Paramètres
- name
-
string
Nom du style de table à récupérer.
Retours
Objet TableStyle dont le nom correspond à l’entrée.
Remarques
[Jeu d’API : ExcelApi 1.10]
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.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection;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.TableStyleCollection;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
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.TableStyleCollection;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
setDefault(newDefaultStyle)
Définit le style de table par défaut à utiliser dans l’étendue de l’objet parent.
setDefault(newDefaultStyle: TableStyle | string): void;Paramètres
- newDefaultStyle
-
Excel.TableStyle | string
L’objet TableStyle , ou le nom de l’objet TableStyle , qui doit être le nouveau par défaut.
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.10]
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.TableStyleCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TableStyleCollectionDataqui 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.TableStyleCollectionData;