Compartilhar via

Excel.DocumentTask class

  • Referência
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 (APENAS PRÉ-VISUALIZAÇÃO) ]

Propriedades

assignees

Devolve uma coleção de detentores da tarefa.
changes

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

Obtém o comentário associado à tarefa.
completedBy

Faz com que o utilizador mais recente tenha concluído a tarefa.
completedDateTime

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

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
createdBy

Obtém o utilizador que criou a tarefa.
createdDateTime

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

Obtém o ID da tarefa.
percentComplete

Especifica a percentagem de conclusão da tarefa. Este é um valor entre 0 e 100, em que 100 representa uma tarefa concluída.
priority

Especifica a prioridade da tarefa. Este é um valor entre 0 e 10, em que 0 representa a prioridade mais alta.
startAndDueDateTime

Obtém ou define a data e hora em que a tarefa deve ser iniciada e está para conclusão.
title

Especifica o título da tarefa.

Métodos

assign(assignee)

Adiciona o utilizador especificado à lista de detentores 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.DocumentTask é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DocumentTaskData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
unassign(assignee)

Remove o utilizador especificado da lista de detentores anexados à tarefa.
unassignAll()

Remove todos os utilizadores da lista de detentores 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.

Devolve uma coleção de detentores da tarefa.

readonly assignees: Excel.EmailIdentity[];

Valor da propriedade

Excel.EmailIdentity[]

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 registos de alteração da tarefa.

readonly changes: Excel.DocumentTaskChangeCollection;

Valor da propriedade

Excel.DocumentTaskChangeCollection

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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.

Faz com que o utilizador mais recente tenha concluído a tarefa.

readonly completedBy: Excel.EmailIdentity;

Valor da propriedade

Excel.EmailIdentity

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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 do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 utilizador que criou a tarefa.

readonly createdBy: Excel.EmailIdentity;

Valor da propriedade

Excel.EmailIdentity

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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 o ID da tarefa.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 a percentagem de conclusão da tarefa. Este é 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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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. Este é um valor entre 0 e 10, em que 0 representa a prioridade mais alta.

priority: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 hora em que a tarefa deve ser iniciada e está para conclusão.

startAndDueDateTime: Excel.DocumentTaskSchedule;

Valor da propriedade

Excel.DocumentTaskSchedule

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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 utilizador especificado à lista de detentores anexados à tarefa.

assign(assignee: Excel.EmailIdentity): void;

Parâmetros

assignee
Excel.EmailIdentity

A identidade do utilizador a adicionar à lista de detentores.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.DocumentTask é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DocumentTaskData) que contém cópias rasas de quaisquer propriedades subordinadas 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 utilizador especificado da lista de detentores anexados à tarefa.

unassign(assignee: Excel.EmailIdentity): void;

Parâmetros

assignee
Excel.EmailIdentity

A identidade do utilizador a remover da lista de detentores.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 utilizadores da lista de detentores anexados à tarefa.

unassignAll(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]