TaskItems2.Add 方法

定义

向添加新的任务项 TaskList

EnvDTE::TaskItem Add(std::wstring const & Category, std::wstring const & SubCategory, std::wstring const & Description, EnvDTE::vsTaskPriority Priority = EnvDTE.vsTaskPriority.vsTaskPriorityMedium, winrt::Windows::Foundation::IInspectable const & Icon, bool Checkable = false, std::wstring const & File = "", int Line = -1, bool CanUserDelete = true, bool FlushItem = true);
[System.Runtime.InteropServices.DispId(4)]
public EnvDTE.TaskItem Add (string Category, string SubCategory, string Description, EnvDTE.vsTaskPriority Priority = EnvDTE.vsTaskPriority.vsTaskPriorityMedium, object Icon, bool Checkable = false, string File = "", int Line = -1, bool CanUserDelete = true, bool FlushItem = true);
[<System.Runtime.InteropServices.DispId(4)>]
abstract member Add : string * string * string * EnvDTE.vsTaskPriority * obj * bool * string * int * bool * bool -> EnvDTE.TaskItem
Public Function Add (Category As String, SubCategory As String, Description As String, Optional Priority As vsTaskPriority = EnvDTE.vsTaskPriority.vsTaskPriorityMedium, Optional Icon As Object, Optional Checkable As Boolean = false, Optional File As String = "", Optional Line As Integer = -1, Optional CanUserDelete As Boolean = true, Optional FlushItem As Boolean = true) As TaskItem

参数

Category
String

必需。 表示任务项的类别名称。

SubCategory
String

必需。 表示任务项的子类别名称。

Description
String

必需。 描述任务项。

Priority
vsTaskPriority

可选。 一个 vsTaskPriority 常数,表示任务项的优先级:高、中或低。 如果值为,则将 vsTaskPriorityHigh任务列表 的第一列中显示感叹号图标。 如果值为 vsTaskPriorityMedium ,则不显示任何内容。 如果值为 vsTaskPriorityLow ,则显示向下箭头图标。

Icon
Object

可选。 确定表示新任务项的图标类型。 设置必须是 vsTaskIconIPictureDisp

Checkable
Boolean

可选。 指示是否要求任务项提供复选框,用户可以通过选择该复选框来指示任务已完成。 默认值为 false

File
String

可选。 指示与新任务项相关联的文件或路径。 默认值为空字符串 ( "" ) ,如果使用此值, IsSettable[vsTaskListColumn] (vsTaskListColumnFile) 返回 false 。 文件名可以是完整路径、相对路径或者只是文件名。 请注意,将文件或路径与项相关联并不一定意味着将执行任何操作。

Line
Int32

可选。 指示源代码中与新任务项相关联的行。 默认值为0,如果使用此值,则 IsSettable[vsTaskListColumn] (vsTaskListColumnLine) 返回 false 。 请注意,将行号与项相关联并不一定意味着将执行任何操作。

CanUserDelete
Boolean

可选。 指示当在环境中选定新任务项时,用户是否可通过按 Delete 删除该项。 默认值为 true

FlushItem
Boolean

可选。 指示新项在 任务列表 中是否立即可见。 当 FlushItem 设置为时 true ,将在调用后立即更新 任务列表 Add 。 如果将 FlushItem 设置为 false ,则在进行所有更新之后,稍后会更新 任务列表false设置主要用于在一次将多个项添加到 任务列表 时增强性能。 默认值为 true

返回

TaskItem

TaskItem 对象。

实现

属性

示例

Imports EnvDTE  
Imports EnvDTE80  
Sub TaskItems2Example(ByVal dte As DTE2)  
    Dim win As Window = _applicationObject.Windows.Item _  
     (Constants.vsWindowKindTaskList)  
    Dim TL As TaskList = CType(win.Object, TaskList)  
    Dim TLItem As TaskItem  
    Dim TLItems As TaskItems2  
    TLItems = CType(TL.TaskItems, TaskItems2)  
    ' Add a couple of tasks to the Task List.  
    TLItem = TLItems.Add(" ", " ", "Test task 1.", _  
     vsTaskPriority.vsTaskPriorityHigh, vsTaskIcon.vsTaskIconUser _  
    , True, , 10, , )  
     TLItem = TLItems.Add(" ", " ", "Test task 2." _  
    , vsTaskPriority.vsTaskPriorityLow, vsTaskIcon.vsTaskIconComment _  
    , , , 20, , )  
    ' List the total number of task list items after adding the new   
    ' task items.  
    MsgBox("Task Item 1 description: " & TLItems.Item(2).Description)  
    MsgBox("Total number of task items: " & TLItems.Count)  
    ' Remove the second task item.  
    ' The items list in reverse numeric order.  
    MsgBox("Deleting the second task item")  
    TLItems.Item(1).Delete()  
    MsgBox("Total number of task items: " & TLItems.Count)  
End Sub  
using EnvDTE;  
using EnvDTE80;  
using System.Windows.Forms;  
public void TaskItems2Example(DTE2 dte)  
{  
    Window2 win = (Window2)_applicationObject.Windows.Item  
(Constants.vsWindowKindTaskList);  
    TaskList TL = (TaskList)win.Object;  
    TaskItem TLItem;  
    TaskItems2 TLItems;  
    TLItems = (TaskItems2)TL.TaskItems;  
    // Add a couple of tasks to the Task List.  
    TLItem = TLItems.Add("MyTask", "MyTask1", "Test task 1."  
, vsTaskPriority.vsTaskPriorityHigh, vsTaskIcon.vsTaskIconUser  
, true,null,10,true,true );  
    TLItem = TLItems.Add("MyTask", "MyTask1", "Test task 2."  
, vsTaskPriority.vsTaskPriorityLow, vsTaskIcon.vsTaskIconComment  
, true, null, 20, true, true);  
    // List the total number of task list items after adding the new  
    // task items.  
    MessageBox.Show("Task Item 1 description: " +   
TLItems.Item(2).Description);  
    MessageBox.Show("Total number of task items: "   
    + TLItems.Count.ToString());  
    // Remove the second task item.  
   // The items list in reverse numeric order.  
    MessageBox.Show("Deleting the second task item");  
    TLItems.Item(1).Delete();  
    MessageBox.Show("Total number of task items: " + TLItems.Count);  
}  

注解

添加位图时,RGB 颜色 0x0000FF00 (绿色) 是透明的。 使用此值的图片中的所有位置都是透明的, 任务列表 通过显示。

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

如果使用 IPictureDisp ,则必须将 PICTYPE 参数设置为 IconBitmapMetafiles、或的设置 Uninitialized 不能 None 正常工作。

适用于