Partager via


Excel.TableStyleCollection class

Représente une collection de styles de tableau.

Extends

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

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.

items

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

Méthodes

add(name, makeUniqueName)

Crée un vide TableStyle avec le nom spécifié.

getCount()

Obtient le nombre de styles de tableaux de la collection.

getDefault()

Obtient le style de tableau par défaut pour l’étendue de l’objet parent.

getItem(name)

Obtient un TableStyle par nom.

getItemOrNullObject(name)

Obtient un TableStyle par nom. Si le style de tableau 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.

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.

setDefault(newDefaultStyle)

Définit le style de tableau par défaut à utiliser dans l’étendue de l’objet parent.

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.TableStyleCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TableStyleCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

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é

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 vide 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

Optional. La valeur par défaut est false. Si truela valeur est , ajoute des nombres au nom afin de le rendre unique, si nécessaire.

Retours

nouvellement créé TableStyle.

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getCount()

Obtient le nombre de styles de tableaux de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getDefault()

Obtient le style de tableau par défaut pour l’étendue de l’objet parent.

getDefault(): Excel.TableStyle;

Retours

Objet TableStyle qui est le style de tableau par défaut actuel.

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItem(name)

Obtient un TableStyle par nom.

getItem(name: string): Excel.TableStyle;

Paramètres

name

string

Nom du style de tableau à récupérer.

Retours

Objet TableStyle dont le nom correspond à l’entrée.

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItemOrNullObject(name)

Obtient un TableStyle par nom. Si le style de tableau 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(name: string): Excel.TableStyle;

Paramètres

name

string

Nom du style de tableau à récupérer.

Retours

Objet TableStyle dont le nom correspond à l’entrée.

Remarques

[ Ensemble 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

options

Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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 qui spécifient 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 tableau par défaut à utiliser dans l’étendue de l’objet parent.

setDefault(newDefaultStyle: TableStyle | string): void;

Paramètres

newDefaultStyle

Excel.TableStyle | string

Objet TableStyle , ou nom de l’objet TableStyle , qui doit être la nouvelle valeur par défaut.

Retours

void

Remarques

[ Ensemble 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.TableStyleCollectionDataque ) 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.TableStyleCollectionData;

Retours