TaskItems.Add (Método)

Actualización: noviembre 2007

Agrega un nuevo elemento de tarea a la TaskList.

Espacio de nombres:  EnvDTE
Ensamblado:  EnvDTE (en EnvDTE.dll)

Sintaxis

Function Add ( _
    Category As String, _
    SubCategory As String, _
    Description As String, _
    Priority As vsTaskPriority, _
    Icon As Object, _
    Checkable As Boolean, _
    File As String, _
    Line As Integer, _
    CanUserDelete As Boolean, _
    FlushItem As Boolean _
) As TaskItem

Dim instance As TaskItems
Dim Category As String
Dim SubCategory As String
Dim Description As String
Dim Priority As vsTaskPriority
Dim Icon As Object
Dim Checkable As Boolean
Dim File As String
Dim Line As Integer
Dim CanUserDelete As Boolean
Dim FlushItem As Boolean
Dim returnValue As TaskItem

returnValue = instance.Add(Category, SubCategory, _
    Description, Priority, Icon, Checkable, _
    File, Line, CanUserDelete, FlushItem)

TaskItem Add(
    string Category,
    string SubCategory,
    string Description,
    vsTaskPriority Priority,
    Object Icon,
    bool Checkable,
    string File,
    int Line,
    bool CanUserDelete,
    bool FlushItem
)

TaskItem^ Add(
    [InAttribute] String^ Category, 
    [InAttribute] String^ SubCategory, 
    [InAttribute] String^ Description, 
    [InAttribute] vsTaskPriority Priority, 
    [InAttribute] Object^ Icon, 
    [InAttribute] bool Checkable, 
    [InAttribute] String^ File, 
    [InAttribute] int Line, 
    [InAttribute] bool CanUserDelete, 
    [InAttribute] bool FlushItem
)

function Add(
    Category : String, 
    SubCategory : String, 
    Description : String, 
    Priority : vsTaskPriority, 
    Icon : Object, 
    Checkable : boolean, 
    File : String, 
    Line : int, 
    CanUserDelete : boolean, 
    FlushItem : boolean
) : TaskItem

Parámetros

• Category
  Tipo: System.String

  Necesario. Representa el nombre de categoría del elemento de tarea.

• SubCategory
  Tipo: System.String

  Necesario. Representa el nombre de la subcategoría del elemento de tarea.

• Description
  Tipo: System.String

  Necesario. Describe el elemento de tarea.

• Priority
  Tipo: EnvDTE.vsTaskPriority

  Opcional. Una constante vsTaskPriority que denota la prioridad del elemento de tarea (alta, media o baja). Si el valor es vsTaskPriorityHigh, se muestra un icono de signo de exclamación en la primera columna de la Lista de tareas. Si el valor es vsTaskPriorityMedium, no se muestra nada. Si el valor es vsTaskPriorityLow, se muestra un icono de flecha hacia abajo.

• Icon
  Tipo: System.Object

  Opcional. Determina el tipo de icono que representa el nuevo elemento de tarea. La configuración debe ser vsTaskIcon o IPictureDisp.

• Checkable
  Tipo: System.Boolean

  Opcional. Indica si desea o no que el elemento de tarea proporcione una casilla de verificación que los usuarios puedan activar para indicar que la tarea se ha completado. El valor predeterminado es false.

• File
  Tipo: System.String

  Opcional. Indica el archivo o la ruta de acceso asociados al nuevo elemento de tarea. El valor predeterminado es una cadena vacía ("") y, si se utiliza, IsSettable(vsTaskListColumnFile) devuelve false. El nombre de archivo puede ser un nombre de ruta de acceso completa, un nombre de ruta de acceso relativa o un simple nombre de archivo. Tenga en cuenta que la asociación de un archivo o una ruta de acceso a un elemento no significa necesariamente que realizará cualquier acción.

• Line
  Tipo: System.Int32

  Opcional. Indica la línea del código fuente asociada al nuevo elemento de tarea. El valor predeterminado es 0 y, si se utiliza, IsSettable(vsTaskListColumnLine) devuelve false. Tenga en cuenta que la asociación de un número de línea a un elemento no significa necesariamente que realizará cualquier acción.

• CanUserDelete
  Tipo: System.Boolean

  Opcional. Indica si un usuario puede eliminar el nuevo elemento de tarea presionando SUPRIMIR cuando el elemento se selecciona en el entorno. El valor predeterminado es true.

• FlushItem
  Tipo: System.Boolean

  Opcional. Indica si un elemento nuevo es visible inmediatamente o no en la Lista de tareas. Cuando FlushItem se establece en True, se actualiza inmediatamente la Lista de tareas después de llamar a Agregar. Cuando FlushItem se establece en false, la Lista de tareas se actualiza una vez hechas todas las actualizaciones. La configuración false se utiliza principalmente para mejorar el rendimiento cuando va a agregar un gran número de elementos a la vez a la Lista de tareas. El valor predeterminado es true.

Valor devuelto

Tipo: EnvDTE.TaskItem

Un objeto TaskItem.

Comentarios

Cuando se agregan mapas de bits, el color RGB 0x0000FF00 (verde) es transparente. Todas las partes de la imagen en las que se utilice este valor serán transparentes y la Lista de tareas se mostrará a través de ellas.

El ancho y el alto de los mapas de bits debe ser de 16 x 16 píxeles.

Si se utiliza IPictureDisp, el argumento PICTYPE se debe establecer en Icon o en Bitmap. La configuración de Metafiles, Uninitialized o None no funcionará correctamente.

Ejemplos

Sub TaskItemsAddExample1()
   Dim win As Window = DTE.Windows.Item(Constants.vsWindowKindTaskList)
   Dim TL As TaskList = win.Object
   Dim TLItem As TaskItem

   ' Add a couple of tasks to the Task List.
   TLItem = TL.TaskItems.Add(" ", " ", "Test task 1.", _
   vsTaskPriority.vsTaskPriorityHigh, vsTaskIcon.vsTaskIconUser, True, _
   "c:\temp.txt", 10, , )
   TLItem = TL.TaskItems.Add(" ", " ", "Test task 2.", _
   vsTaskPriority.vsTaskPriorityLow, vsTaskIcon.vsTaskIconComment, _
   False, "c:\temp2.txt", 20, , )
   ' List the total number of task list items after adding the new 
   ' task items.
   MsgBox("Task Item 1 description: " & TL.TaskItems.Item(2).Description)
   MsgBox("Total number of task items: " & TL.TaskItems.Count)

   ' Remove the second task item. The items list in reverse numeric order.
   MsgBox("Deleting the second task item")
   TL.TaskItems.Item(1).Delete()
   MsgBox("Total number of task items: " & TL.TaskItems.Count)
End Sub

Permisos

• Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.

Vea también

Referencia

TaskItems (Interfaz)

TaskItems (Miembros)

EnvDTE (Espacio de nombres)