Excel.TimelineStyleCollection class
Représente une collection de styles de chronologie.
- 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 vide |
| get |
Obtient le nombre de styles de délai de la collection. |
| get |
Obtient le style de chronologie par défaut pour l’étendue de l’objet parent. |
| 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 chronologie 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.TimelineStyle[];Valeur de propriété
Détails de la méthode
add(name, makeUniqueName)
Crée un vide TimelineStyle avec le nom spécifié.
add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;Paramètres
- name
-
string
Nom unique du nouveau style de chronologie. 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éé TimelineStyle.
Remarques
getCount()
Obtient le nombre de styles de délai de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getDefault()
Obtient le style de chronologie par défaut pour l’étendue de l’objet parent.
getDefault(): Excel.TimelineStyle;Retours
Objet TimelineStyle qui est le style de chronologie par défaut actuel.
Remarques
getItem(name)
Obtient un TimelineStyle par nom.
getItem(name: string): Excel.TimelineStyle;Paramètres
- name
-
string
Nom du style de chronologie à récupérer.
Retours
Objet TimelineStyle dont le nom correspond à l’entrée.
Remarques
getItemOrNullObject(name)
Obtient un TimelineStyle par nom. Si le style de chronologie 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.TimelineStyle;Paramètres
- name
-
string
Nom du style de chronologie à récupérer.
Retours
Objet TimelineStyle 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.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;Paramètres
- options
-
Excel.Interfaces.TimelineStyleCollectionLoadOptions & 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.TimelineStyleCollection;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.TimelineStyleCollection;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 chronologie par défaut à utiliser dans l’étendue de l’objet parent.
setDefault(newDefaultStyle: TimelineStyle | string): void;Paramètres
- newDefaultStyle
-
Excel.TimelineStyle | string
Objet TimelineStyle , ou nom de l’objet TimelineStyle , 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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.TimelineStyleCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.TimelineStyleCollectionDataque ) 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.TimelineStyleCollectionData;