Excel.DocumentTask class
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Представляет задачу.
- Extends
Свойства
| assignees | Возвращает коллекцию назначенных задач. |
| changes | Получает записи изменений по задаче. |
| comment | Получает комментарий, связанный с задачей. |
| completed |
Получает последнего пользователя, завершившего задачу. |
| completed |
Получает дату и время завершения задачи. Все даты указаны в формате UTC. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| created |
Получает пользователя, создавшего задачу. |
| created |
Получает дату и время создания задачи. Все даты указаны в формате UTC. |
| id | Получает идентификатор задачи. |
| percent |
Определяет процент завершения задачи. Это значение от 0 до 100, где 100 представляет завершенную задачу. |
| priority | Определяет приоритет задачи. Это значение от 0 до 10, где 0 представляет наивысший приоритет. |
| start |
Указывает дату и время начала и времени выполнения задачи. |
| title | Указывает название задачи. |
Методы
| assign(assignee) | Добавляет данного пользователя в список назначенных на задачу. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| unassign(assignee) | Удаляет данного пользователя из списка назначенных на задачу. |
| unassign |
Удаляет всех пользователей из списка назначений, прикрепленных к задаче. |
Сведения о свойстве
assignees
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает коллекцию назначенных задач.
readonly assignees: Excel.EmailIdentity[];Значение свойства
Комментарии
changes
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает записи изменений по задаче.
readonly changes: Excel.DocumentTaskChangeCollection;Значение свойства
Комментарии
comment
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает комментарий, связанный с задачей.
readonly comment: Excel.Comment;Значение свойства
Комментарии
completedBy
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает последнего пользователя, завершившего задачу.
readonly completedBy: Excel.EmailIdentity;Значение свойства
Комментарии
completedDateTime
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает дату и время завершения задачи. Все даты указаны в формате UTC.
readonly completedDateTime: Date;Значение свойства
Date
Комментарии
context
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
createdBy
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает пользователя, создавшего задачу.
readonly createdBy: Excel.EmailIdentity;Значение свойства
Комментарии
createdDateTime
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает дату и время создания задачи. Все даты указаны в формате UTC.
readonly createdDateTime: Date;Значение свойства
Date
Комментарии
id
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Получает идентификатор задачи.
readonly id: string;Значение свойства
string
Комментарии
percentComplete
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Определяет процент завершения задачи. Это значение от 0 до 100, где 100 представляет завершенную задачу.
percentComplete: number;Значение свойства
number
Комментарии
priority
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Определяет приоритет задачи. Это значение от 0 до 10, где 0 представляет наивысший приоритет.
priority: number;Значение свойства
number
Комментарии
startAndDueDateTime
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает дату и время начала и времени выполнения задачи.
startAndDueDateTime: Excel.DocumentTaskSchedule;Значение свойства
Комментарии
title
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает название задачи.
title: string;Значение свойства
string
Комментарии
Сведения о методе
assign(assignee)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Добавляет данного пользователя в список назначенных на задачу.
assign(assignee: Excel.EmailIdentity): void;Параметры
- assignee
- Excel.EmailIdentity
Удостоверение пользователя, добавляемого в список уполномоченных.
Возвращаемое значение
void
Комментарии
load(options)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.DocumentTaskLoadOptions): Excel.DocumentTask;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.DocumentTask;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DocumentTask;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.DocumentTask объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.DocumentTaskData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.DocumentTaskData;Возвращаемое значение
unassign(assignee)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Удаляет данного пользователя из списка назначенных на задачу.
unassign(assignee: Excel.EmailIdentity): void;Параметры
- assignee
- Excel.EmailIdentity
Удостоверение пользователя, которого нужно удалить из списка уполномоченных.
Возвращаемое значение
void
Комментарии
unassignAll()
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Удаляет всех пользователей из списка назначений, прикрепленных к задаче.
unassignAll(): void;Возвращаемое значение
void