Excel.DocumentTaskCollection class

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Représente une collection de tâches.

Extends

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

Propriétés

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

items

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

Méthodes

getCount()

Obtient le nombre de tâches dans la collection.

getItem(key)

Obtient une tâche à l’aide de son ID.

getItemAt(index)

Obtient une tâche par son index dans la collection.

getItemOrNullObject(key)

Obtient une tâche à l’aide de son ID.

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.

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que Excel.DocumentTaskCollection l’objet d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.DocumentTaskCollectionData) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

items

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

readonly items: Excel.DocumentTask[];

Valeur de propriété

Détails de la méthode

getCount()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient le nombre de tâches dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

getItem(key)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient une tâche à l’aide de son ID.

getItem(key: string): Excel.DocumentTask;

Paramètres

key

string

ID de la tâche.

Retours

Tâche avec l’ID donné. S’il n’existe aucune tâche avec l’ID donné, une ItemNotFound exception est lancée.

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

getItemAt(index)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient une tâche par son index dans la collection.

getItemAt(index: number): Excel.DocumentTask;

Paramètres

index

number

Index de la tâche dans la collection.

Retours

Tâche avec l’index donné.

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

getItemOrNullObject(key)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient une tâche à l’aide de son ID.

getItemOrNullObject(key: string): Excel.DocumentTask;

Paramètres

key

string

ID de la tâche.

Retours

Tâche avec l’ID donné. S’il n’existe aucune tâche avec l’ID donné, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, * voir méthodes et propriétés OrNullObject.

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

load(options)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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.DocumentTaskCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DocumentTaskCollection;

Paramètres

options

Excel.Interfaces.DocumentTaskCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retours

load(propertyNames)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

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)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

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 est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

toJSON()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que Excel.DocumentTaskCollection l’objet d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.DocumentTaskCollectionData) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.DocumentTaskCollectionData;

Retours