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 の場合、タスク一覧の 1 列目に感嘆符のアイコンが表示されます。値が 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
省略可能です。環境内でアイテムが選択されているときに、ユーザーが Del キーを押して新しいタスク アイテムを削除できるかどうかを示します。既定値は true です。
- FlushItem
型 : System.Boolean
省略可能です。新しいアイテムが [タスク一覧] にすぐに表示されるかどうかを示します。 FlushItem に True を設定した場合、Add メソッドが呼び出された直後にタスク一覧が更新されます。 FlushItem に false を設定した場合は、すべての更新が行われた後、しばらくしてからタスク一覧が更新されます。 false の設定は、一度に多数のアイテムをタスク一覧に追加するときに、主にパフォーマンスを向上させるために使用します。既定値は true です。
戻り値
型 : EnvDTE.TaskItem
TaskItem オブジェクト。
解説
ビットマップを追加する場合、RGB カラー 0x0000FF00 (緑) は透明になっています。この値を使用する画像の全領域が透明になるため、タスク一覧は透過的に表示されます。
ビットマップの幅と高さは、16 × 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 セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。