Excel.DocumentTask class

  • Référence
Paquet:
excel

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 tâche.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

Propriétés

assignees

Retourne une collection de personnes assignées de la tâche.
changes

Obtient les enregistrements de modification de la tâche.
comment

Obtient le commentaire associé à la tâche.
completedBy

Obtient l’utilisateur le plus récent à avoir terminé la tâche.
completedDateTime

Obtient la date et l’heure auxquelles la tâche a été terminée. Toutes les dates sont au format UTC.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
createdBy

Obtient l’utilisateur qui a créé la tâche.
createdDateTime

Obtient la date et l’heure de création de la tâche. Toutes les dates sont au format UTC.
id

Obtient l’ID de la tâche.
percentComplete

Spécifie le pourcentage d’achèvement de la tâche. Il s’agit d’une valeur comprise entre 0 et 100, où 100 représente une tâche terminée.
priority

Spécifie la priorité de la tâche. Il s’agit d’une valeur comprise entre 0 et 10, où 0 représente la priorité la plus élevée.
startAndDueDateTime

Obtient ou définit la date et l’heure à laquelle la tâche doit démarrer et est arrivée à échéance.
title

Spécifie le titre de la tâche.

Méthodes

assign(assignee)

Ajoute l’utilisateur donné à la liste des personnes associées à la tâche.
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 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.DocumentTask est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.DocumentTaskDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
unassign(assignee)

Supprime l’utilisateur donné de la liste des ayants droit attachés à la tâche.
unassignAll()

Supprime tous les utilisateurs de la liste des ayants droit attachés à la tâche.

Détails de la propriété

assignees

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.

Retourne une collection de personnes assignées de la tâche.

readonly assignees: Excel.EmailIdentity[];

Valeur de propriété

Excel.EmailIdentity[]

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

changes

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 les enregistrements de modification de la tâche.

readonly changes: Excel.DocumentTaskChangeCollection;

Valeur de propriété

Excel.DocumentTaskChangeCollection

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

comment

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 commentaire associé à la tâche.

readonly comment: Excel.Comment;

Valeur de propriété

Excel.Comment

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

completedBy

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’utilisateur le plus récent à avoir terminé la tâche.

readonly completedBy: Excel.EmailIdentity;

Valeur de propriété

Excel.EmailIdentity

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

completedDateTime

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 la date et l’heure auxquelles la tâche a été terminée. Toutes les dates sont au format UTC.

readonly completedDateTime: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

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

Excel.RequestContext

createdBy

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’utilisateur qui a créé la tâche.

readonly createdBy: Excel.EmailIdentity;

Valeur de propriété

Excel.EmailIdentity

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

createdDateTime

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 la date et l’heure de création de la tâche. Toutes les dates sont au format UTC.

readonly createdDateTime: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

id

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’ID de la tâche.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

percentComplete

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.

Spécifie le pourcentage d’achèvement de la tâche. Il s’agit d’une valeur comprise entre 0 et 100, où 100 représente une tâche terminée.

percentComplete: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

priority

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.

Spécifie la priorité de la tâche. Il s’agit d’une valeur comprise entre 0 et 10, où 0 représente la priorité la plus élevée.

priority: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

startAndDueDateTime

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 ou définit la date et l’heure à laquelle la tâche doit démarrer et est arrivée à échéance.

startAndDueDateTime: Excel.DocumentTaskSchedule;

Valeur de propriété

Excel.DocumentTaskSchedule

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

title

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.

Spécifie le titre de la tâche.

title: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

Détails de la méthode

assign(assignee)

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.

Ajoute l’utilisateur donné à la liste des personnes associées à la tâche.

assign(assignee: Excel.EmailIdentity): void;

Paramètres

assignee
Excel.EmailIdentity

Identité de l’utilisateur à ajouter à la liste des destinataires.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION 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.DocumentTaskLoadOptions): Excel.DocumentTask;

Paramètres

options
Excel.Interfaces.DocumentTaskLoadOptions

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

Retours

Excel.DocumentTask

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

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

Excel.DocumentTask

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

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.DocumentTask

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 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.DocumentTask est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.DocumentTaskDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.DocumentTaskData;

Retours

Excel.Interfaces.DocumentTaskData

unassign(assignee)

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.

Supprime l’utilisateur donné de la liste des ayants droit attachés à la tâche.

unassign(assignee: Excel.EmailIdentity): void;

Paramètres

assignee
Excel.EmailIdentity

Identité de l’utilisateur à supprimer de la liste des destinataires.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

unassignAll()

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.

Supprime tous les utilisateurs de la liste des ayants droit attachés à la tâche.

unassignAll(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]