Excel.SlicerStyleCollection class
Représente une collection d’objets SlicerStyle
.
- 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, make |
Crée un style de segment vide avec le nom spécifié. |
get |
Obtient le nombre de styles de slicer de la collection. |
get |
Obtient la valeur par défaut |
get |
Obtient un |
get |
Obtient un |
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 segment 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 . 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.SlicerStyle[];
Valeur de propriété
Détails de la méthode
add(name, makeUniqueName)
Crée un style de segment vide avec le nom spécifié.
add(name: string, makeUniqueName?: boolean): Excel.SlicerStyle;
Paramètres
- name
-
string
Nom unique du nouveau style de segment. Lève une InvalidArgument
exception si le nom est déjà utilisé.
- makeUniqueName
-
boolean
Optional. La valeur par défaut est false
. Si true
la valeur est , ajoute des nombres au nom afin de le rendre unique, si nécessaire.
Retours
nouvellement créé SlicerStyle
.
Remarques
getCount()
Obtient le nombre de styles de slicer de la collection.
getCount(): OfficeExtension.ClientResult<number>;
Retours
OfficeExtension.ClientResult<number>
Remarques
getDefault()
Obtient la valeur par défaut SlicerStyle
pour l’étendue de l’objet parent.
getDefault(): Excel.SlicerStyle;
Retours
Objet SlicerStyle
qui est le style de segment par défaut actuel.
Remarques
getItem(name)
Obtient un SlicerStyle
par nom.
getItem(name: string): Excel.SlicerStyle;
Paramètres
- name
-
string
Nom du style de segment à récupérer.
Retours
Objet SlicerStyle
dont le nom correspond à l’entrée.
Remarques
getItemOrNullObject(name)
Obtient un SlicerStyle
par nom. Si le style de segment 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.SlicerStyle;
Paramètres
- name
-
string
Nom du style de segment à récupérer.
Retours
Objet SlicerStyle
dont le nom correspond à l’entrée.
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.SlicerStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerStyleCollection;
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.SlicerStyleCollection;
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.SlicerStyleCollection;
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 segment par défaut à utiliser dans l’étendue de l’objet parent.
setDefault(newDefaultStyle: SlicerStyle | string): void;
Paramètres
- newDefaultStyle
-
Excel.SlicerStyle | string
Objet SlicerStyle
, ou nom de l’objet SlicerStyle
, qui doit être la nouvelle valeur par défaut.
Retours
void
Remarques
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
appelle à son tour la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.SlicerStyleCollection
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.SlicerStyleCollectionData
que ) 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.SlicerStyleCollectionData;