Compartir a través de

Excel.DocumentTask class

  • Referencia
Paquete:
excel

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa una tarea.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Propiedades

assignees

Devuelve una colección de asignados de la tarea.
changes

Obtiene los registros de cambios de la tarea.
comment

Obtiene el comentario asociado a la tarea.
completedBy

Obtiene el usuario más reciente que ha completado la tarea.
completedDateTime

Obtiene la fecha y hora en que se completó la tarea. Todas las fechas están en UTC.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
createdBy

Obtiene el usuario que creó la tarea.
createdDateTime

Obtiene la fecha y hora en que se creó la tarea. Todas las fechas están en UTC.
id

Obtiene el identificador de la tarea.
percentComplete

Especifica el porcentaje de finalización de la tarea. Se trata de un valor entre 0 y 100, donde 100 representa una tarea completada.
priority

Especifica la prioridad de la tarea. Se trata de un valor entre 0 y 10, donde 0 representa la prioridad más alta.
startAndDueDateTime

Obtiene o establece la fecha y hora en que se debe iniciar la tarea y que se vence.
title

Especifica el título de la tarea.

Métodos

assign(assignee)

Agrega el usuario especificado a la lista de asignados adjuntos a la tarea.
load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.DocumentTask es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.DocumentTaskData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
unassign(assignee)

Quita el usuario especificado de la lista de asignados adjuntos a la tarea.
unassignAll()

Quita todos los usuarios de la lista de asignados adjuntos a la tarea.

Detalles de las propiedades

assignees

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Devuelve una colección de asignados de la tarea.

readonly assignees: Excel.EmailIdentity[];

Valor de propiedad

Excel.EmailIdentity[]

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

changes

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene los registros de cambios de la tarea.

readonly changes: Excel.DocumentTaskChangeCollection;

Valor de propiedad

Excel.DocumentTaskChangeCollection

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

comment

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el comentario asociado a la tarea.

readonly comment: Excel.Comment;

Valor de propiedad

Excel.Comment

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

completedBy

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el usuario más reciente que ha completado la tarea.

readonly completedBy: Excel.EmailIdentity;

Valor de propiedad

Excel.EmailIdentity

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

completedDateTime

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la fecha y hora en que se completó la tarea. Todas las fechas están en UTC.

readonly completedDateTime: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

context

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

createdBy

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el usuario que creó la tarea.

readonly createdBy: Excel.EmailIdentity;

Valor de propiedad

Excel.EmailIdentity

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

createdDateTime

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la fecha y hora en que se creó la tarea. Todas las fechas están en UTC.

readonly createdDateTime: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

id

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el identificador de la tarea.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

percentComplete

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica el porcentaje de finalización de la tarea. Se trata de un valor entre 0 y 100, donde 100 representa una tarea completada.

percentComplete: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

priority

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica la prioridad de la tarea. Se trata de un valor entre 0 y 10, donde 0 representa la prioridad más alta.

priority: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

startAndDueDateTime

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene o establece la fecha y hora en que se debe iniciar la tarea y que se vence.

startAndDueDateTime: Excel.DocumentTaskSchedule;

Valor de propiedad

Excel.DocumentTaskSchedule

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

title

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica el título de la tarea.

title: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Detalles del método

assign(assignee)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Agrega el usuario especificado a la lista de asignados adjuntos a la tarea.

assign(assignee: Excel.EmailIdentity): void;

Parámetros

assignee
Excel.EmailIdentity

Identidad del usuario que se va a agregar a la lista de asignados.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

load(options)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options
Excel.Interfaces.DocumentTaskLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.DocumentTask

load(propertyNames)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.DocumentTask

load(propertyNamesAndPaths)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.DocumentTask

toJSON()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.DocumentTask es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.DocumentTaskData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.DocumentTaskData;

Devoluciones

Excel.Interfaces.DocumentTaskData

unassign(assignee)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Quita el usuario especificado de la lista de asignados adjuntos a la tarea.

unassign(assignee: Excel.EmailIdentity): void;

Parámetros

assignee
Excel.EmailIdentity

Identidad del usuario que se va a quitar de la lista de asignados.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

unassignAll()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Quita todos los usuarios de la lista de asignados adjuntos a la tarea.

unassignAll(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]