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
必要項。表示工作項目的子類別名稱。
- Description
型別:System.String
必要項。描述工作項目。
- Priority
型別:EnvDTE.vsTaskPriority
選擇項。vsTaskPriority 常數代表工作項目的優先性 (高、中或低)。如果值為 vsTaskPriorityHigh,驚嘆號圖示會顯示於工作清單的第一行中。如果這個值為 vsTaskPriorityMedium,則不會有任何顯示。如果這個值為 vsTaskPriorityLow,則顯示向下箭號圖示。
- 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 安全性
- 完全信任立即呼叫者。這個成員無法供部分信任的程式碼使用。如需詳細資訊,請參閱從部分受信任程式碼使用程式庫。