Share via

TaskItems.Add 方法

  • 项目

向 TaskList 添加新的任务项。

命名空间：  EnvDTE
程序集：  EnvDTE（在 EnvDTE.dll 中）

语法

声明
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

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
)

abstract Add : 
        Category:string * 
        SubCategory:string * 
        Description:string * 
        Priority:vsTaskPriority * 
        Icon:Object * 
        Checkable:bool * 
        File:string * 
        Line:int * 
        CanUserDelete:bool * 
        FlushItem:bool -> TaskItem 

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

参数

  • Category
    类型：System.String
    必选。表示任务项的类别名称。
  • SubCategory
    类型：System.String
    必选。表示任务项的子类别名称。
  • Icon
    类型：System.Object
    可选。确定表示新任务项的图标类型。它只能设置为 vsTaskIcon 或 IPictureDisp。
  • Checkable
    类型：System.Boolean
    可选。指示是否求任务项提供复选框，用户可以通过选择该复选框来指示任务已完成。默认值为 false。
  • File
    类型：System.String
    可选。指示与新任务项相关联的文件或路径。默认值为空字符串 ("")，如果使用此默认值，则 IsSettable(vsTaskListColumnFile) 返回 false。文件名称可以是完整路径名称、相对路径名称或者只有文件名称。请注意，将文件或路径与项相关联并不一定意味着将执行操作。
  • Line
    类型：System.Int32
    可选。指示源代码中与新任务项相关联的行。默认值为 0，如果使用此默认值，则 IsSettable(vsTaskListColumnLine) 返回 false。请注意，将行号与项相关联并不一定意味着将执行操作。
  • CanUserDelete
    类型：System.Boolean
    可选。指示当在环境中选定新任务项时，用户是否可通过按 Delete 删除该项。默认值为 true。
  • FlushItem
    类型：System.Boolean
    可选。指示新项在**“任务列表”**中是否立即可见。如果 FlushItem 设置为 True，则在调用“Add”后立即更新“任务列表”。如果 FlushItem 设置为 false，则在完成所有更新后才更新“任务列表”。false 设置主要用于在一次向“任务列表”添加大量项时来增强性能。默认值为 true。

返回值

类型：EnvDTE.TaskItem
一个 TaskItem 对象。

备注

添加位图时，RGB 色 0x0000FF00（绿色）是透明的。 图片中所有使用该值的地方都将是透明的，**“任务列表”**可以透视。

位图的宽和高必须是 16 x 16 像素。

如果使用 IPictureDisp，则必须将 PICTYPE 参数设置为 Icon 或 Bitmap。 设置为 Metafiles、Uninitialized 或 None 将无法正常使用。

示例

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

.NET Framework 安全性

请参见

参考

TaskItems 接口

EnvDTE 命名空间