Excel.TimelineStyle class

Paquet:

excel

Représente un TimelineStyle, qui définit les éléments de style par région dans la chronologie.

Extends

OfficeExtension.ClientObject

Remarques

Jeu d’API : ExcelApi 1.10

Utilisateur

• Excel.TimelineStyleCollection : add, getDefault, getItem, getItemOrNullObject, items, setDefault

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.
name	Spécifie le nom du style de la chronologie.
readOnly	Spécifie si cet TimelineStyle objet est en lecture seule.

Méthodes

delete()	Supprime le style de tableau.
duplicate()	Crée une copie de ce style de chronologie avec des copies de tous les éléments de style.
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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
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.TimelineStyle est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TimelineStyleDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

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é

Excel.RequestContext

name

Spécifie le nom du style de la chronologie.

name: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.10

readOnly

Spécifie si cet TimelineStyle objet est en lecture seule.

readonly readOnly: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.10

Détails de la méthode

delete()

Supprime le style de tableau.

delete(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.10

duplicate()

Crée une copie de ce style de chronologie avec des copies de tous les éléments de style.

duplicate(): Excel.TimelineStyle;

Retours

Excel.TimelineStyle

Nouvel TimelineStyle objet dupliqué à partir de ce style de chronologie.

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.TimelineStyleLoadOptions): Excel.TimelineStyle;

Paramètres

options

Excel.Interfaces.TimelineStyleLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.TimelineStyle

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.TimelineStyle;

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

Excel.TimelineStyle

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?: {
            select?: string;
            expand?: string;
        }): Excel.TimelineStyle;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

Excel.TimelineStyle

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.TimelineStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.TimelineStyleUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.TimelineStyle): void;

Paramètres

properties

Excel.TimelineStyle

Retours

void

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.TimelineStyle est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TimelineStyleDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.TimelineStyleData;

Retours

Excel.Interfaces.TimelineStyleData