Excel.DocumentTask class

Pacote:

excel

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa uma tarefa.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Propriedades

assignees	Retorna uma coleção de atribuições da tarefa.
changes	Obtém os registros de alteração da tarefa.
comment	Obtém o comentário associado à tarefa.
completedBy	Obtém o usuário mais recente a ter concluído a tarefa.
completedDateTime	Obtém a data e a hora em que a tarefa foi concluída. Todas as datas estão em UTC.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
createdBy	Obtém o usuário que criou a tarefa.
createdDateTime	Obtém a data e a hora em que a tarefa foi criada. Todas as datas estão em UTC.
id	Obtém a ID da tarefa.
percentComplete	Especifica o percentual de conclusão da tarefa. Esse é um valor entre 0 e 100, em que 100 representa uma tarefa concluída.
priority	Especifica a prioridade da tarefa. Esse é um valor entre 0 e 10, em que 0 representa a maior prioridade.
startAndDueDateTime	Obtém ou define a data e a hora em que a tarefa deve ser iniciada e deve ser concluída.
title	Especifica o título da tarefa.

Métodos

assign(assignee)	Adiciona o usuário determinado à lista de atribuídos anexados à tarefa.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DocumentTask original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DocumentTaskData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
unassign(assignee)	Remove o usuário determinado da lista de atribuidores anexados à tarefa.
unassignAll()	Remove todos os usuários da lista de atribuidores anexados à tarefa.

Detalhes da propriedade

assignees

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna uma coleção de atribuições da tarefa.

readonly assignees: Excel.EmailIdentity[];

Valor da propriedade

Excel.EmailIdentity[]

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

changes

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém os registros de alteração da tarefa.

readonly changes: Excel.DocumentTaskChangeCollection;

Valor da propriedade

Excel.DocumentTaskChangeCollection

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

comment

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o comentário associado à tarefa.

readonly comment: Excel.Comment;

Valor da propriedade

Excel.Comment

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

completedBy

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o usuário mais recente a ter concluído a tarefa.

readonly completedBy: Excel.EmailIdentity;

Valor da propriedade

Excel.EmailIdentity

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

completedDateTime

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém a data e a hora em que a tarefa foi concluída. Todas as datas estão em UTC.

readonly completedDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

context

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

createdBy

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém o usuário que criou a tarefa.

readonly createdBy: Excel.EmailIdentity;

Valor da propriedade

Excel.EmailIdentity

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

createdDateTime

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém a data e a hora em que a tarefa foi criada. Todas as datas estão em UTC.

readonly createdDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

id

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém a ID da tarefa.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

percentComplete

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica o percentual de conclusão da tarefa. Esse é um valor entre 0 e 100, em que 100 representa uma tarefa concluída.

percentComplete: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

priority

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica a prioridade da tarefa. Esse é um valor entre 0 e 10, em que 0 representa a maior prioridade.

priority: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

startAndDueDateTime

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém ou define a data e a hora em que a tarefa deve ser iniciada e deve ser concluída.

startAndDueDateTime: Excel.DocumentTaskSchedule;

Valor da propriedade

Excel.DocumentTaskSchedule

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

title

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica o título da tarefa.

title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Detalhes do método

assign(assignee)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Adiciona o usuário determinado à lista de atribuídos anexados à tarefa.

assign(assignee: Excel.EmailIdentity): void;

Parâmetros

assignee

Excel.EmailIdentity

A identidade do usuário a ser adicionada à lista de atribuídos.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

load(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options

Excel.Interfaces.DocumentTaskLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.DocumentTask

load(propertyNames)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.DocumentTask

load(propertyNamesAndPaths)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.DocumentTask

toJSON()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DocumentTask original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DocumentTaskData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.DocumentTaskData;

Retornos

Excel.Interfaces.DocumentTaskData

unassign(assignee)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Remove o usuário determinado da lista de atribuidores anexados à tarefa.

unassign(assignee: Excel.EmailIdentity): void;

Parâmetros

assignee

Excel.EmailIdentity

A identidade do usuário a ser removido da lista de atribuídos.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

unassignAll()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Remove todos os usuários da lista de atribuidores anexados à tarefa.

unassignAll(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]