Excel.DocumentTask class

  • Ссылка
Пакет:
excel

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет задачу.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Свойства

assignees

Возвращает коллекцию назначенных задач.
changes

Возвращает записи об изменениях задачи.
comment

Возвращает комментарий, связанный с задачей.
completedBy

Возвращает последнего пользователя, завершив задачу.
completedDateTime

Возвращает дату и время завершения задачи. Все даты указаны в формате UTC.
context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
createdBy

Возвращает пользователя, создавшего задачу.
createdDateTime

Возвращает дату и время создания задачи. Все даты указаны в формате UTC.
id

Возвращает идентификатор задачи.
percentComplete

Указывает процент завершения задачи. Это значение от 0 до 100, где 100 представляет собой завершенную задачу.
priority

Указывает приоритет задачи. Это значение от 0 до 10, где 0 представляет наивысший приоритет.
startAndDueDateTime

Возвращает или задает дату и время начала и срока выполнения задачи.
title

Задает заголовок задачи.

Методы

assign(assignee)

Добавляет заданного пользователя в список назначенных пользователей, присоединенный к задаче.
load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.DocumentTask объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.DocumentTaskData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
unassign(assignee)

Удаляет заданного пользователя из списка назначенных пользователей, присоединенного к задаче.
unassignAll()

Удаляет всех пользователей из списка назначенных, присоединенных к задаче.

Сведения о свойстве

assignees

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает коллекцию назначенных задач.

readonly assignees: Excel.EmailIdentity[];

Значение свойства

Excel.EmailIdentity[]

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

changes

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает записи об изменениях задачи.

readonly changes: Excel.DocumentTaskChangeCollection;

Значение свойства

Excel.DocumentTaskChangeCollection

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

comment

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает комментарий, связанный с задачей.

readonly comment: Excel.Comment;

Значение свойства

Excel.Comment

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

completedBy

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает последнего пользователя, завершив задачу.

readonly completedBy: Excel.EmailIdentity;

Значение свойства

Excel.EmailIdentity

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

completedDateTime

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает дату и время завершения задачи. Все даты указаны в формате UTC.

readonly completedDateTime: Date;

Значение свойства

Date

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

context

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

createdBy

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает пользователя, создавшего задачу.

readonly createdBy: Excel.EmailIdentity;

Значение свойства

Excel.EmailIdentity

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

createdDateTime

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает дату и время создания задачи. Все даты указаны в формате UTC.

readonly createdDateTime: Date;

Значение свойства

Date

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

id

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает идентификатор задачи.

readonly id: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

percentComplete

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает процент завершения задачи. Это значение от 0 до 100, где 100 представляет собой завершенную задачу.

percentComplete: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

priority

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает приоритет задачи. Это значение от 0 до 10, где 0 представляет наивысший приоритет.

priority: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

startAndDueDateTime

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает или задает дату и время начала и срока выполнения задачи.

startAndDueDateTime: Excel.DocumentTaskSchedule;

Значение свойства

Excel.DocumentTaskSchedule

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

title

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Задает заголовок задачи.

title: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

Сведения о методе

assign(assignee)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет заданного пользователя в список назначенных пользователей, присоединенный к задаче.

assign(assignee: Excel.EmailIdentity): void;

Параметры

assignee
Excel.EmailIdentity

Удостоверение пользователя, добавляемого в список назначаемых.

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

load(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.DocumentTaskLoadOptions): Excel.DocumentTask;

Параметры

options
Excel.Interfaces.DocumentTaskLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.DocumentTask

load(propertyNames)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.DocumentTask;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.DocumentTask

load(propertyNamesAndPaths)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DocumentTask;

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.DocumentTask

toJSON()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.DocumentTask объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.DocumentTaskData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.DocumentTaskData;

Возвращаемое значение

Excel.Interfaces.DocumentTaskData

unassign(assignee)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Удаляет заданного пользователя из списка назначенных пользователей, присоединенного к задаче.

unassign(assignee: Excel.EmailIdentity): void;

Параметры

assignee
Excel.EmailIdentity

Удостоверение пользователя, удаляемого из списка назначаемых.

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

unassignAll()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Удаляет всех пользователей из списка назначенных, присоединенных к задаче.

unassignAll(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]