TaskItems2.Add2 メソッド
更新 : 2007 年 11 月
TaskList に新しいタスク アイテムを追加します。
名前空間 : EnvDTE80
アセンブリ : EnvDTE80 (EnvDTE80.dll 内)
構文
'宣言
Function Add2 ( _
Category As String, _
SubCategory As String, _
Description As String, _
Priority As Integer, _
Icon As Object, _
Checkable As Boolean, _
File As String, _
Line As Integer, _
CanUserDelete As Boolean, _
FlushItem As Boolean, _
AutoNavigate As Boolean _
) As TaskItem
'使用
Dim instance As TaskItems2
Dim Category As String
Dim SubCategory As String
Dim Description As String
Dim Priority As Integer
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 AutoNavigate As Boolean
Dim returnValue As TaskItem
returnValue = instance.Add2(Category, _
SubCategory, Description, Priority, _
Icon, Checkable, File, Line, CanUserDelete, _
FlushItem, AutoNavigate)
TaskItem Add2(
string Category,
string SubCategory,
string Description,
int Priority,
Object Icon,
bool Checkable,
string File,
int Line,
bool CanUserDelete,
bool FlushItem,
bool AutoNavigate
)
TaskItem^ Add2(
[InAttribute] String^ Category,
[InAttribute] String^ SubCategory,
[InAttribute] String^ Description,
[InAttribute] int Priority,
[InAttribute] Object^ Icon,
[InAttribute] bool Checkable,
[InAttribute] String^ File,
[InAttribute] int Line,
[InAttribute] bool CanUserDelete,
[InAttribute] bool FlushItem,
[InAttribute] bool AutoNavigate
)
function Add2(
Category : String,
SubCategory : String,
Description : String,
Priority : int,
Icon : Object,
Checkable : boolean,
File : String,
Line : int,
CanUserDelete : boolean,
FlushItem : boolean,
AutoNavigate : boolean
) : TaskItem
パラメータ
Category
型 : System.String必ず指定します。タスク アイテムのカテゴリ名。
SubCategory
型 : System.String必ず指定します。タスク アイテムのサブカテゴリ名。
Description
型 : System.String必ず指定します。タスク アイテムの説明。
Priority
型 : System.Int32省略可能です。タスク アイテムの優先度 (高、中、低) を示す 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省略可能です。環境内でアイテムが選択されているときに、ユーザーが Del キーを押して新しいタスク アイテムを削除できるかどうかを示します。既定値は、true です。
FlushItem
型 : System.Boolean省略可能です。新しいアイテムが [タスク一覧] にすぐに表示されるかどうかを示します。FlushItem を true に設定すると、Add が呼び出された直後に [タスク一覧] が更新されます。FlushItem を false に設定すると、すべての更新が行われた後に [タスク一覧] が更新されます。false の設定は、主に、一度に多くのアイテムを [タスク一覧] に追加する場合のパフォーマンスを向上するために使用されます。既定値は、true です。
AutoNavigate
型 : System.Boolean省略できます。TaskItem で AutoNavigate 機能が有効になっているかどうかを示します。AutoNavigate を有効にする場合はパラメータを true に設定します。それ以外の場合は false に設定します。
戻り値
型 : EnvDTE.TaskItem
TaskItem オブジェクト。
解説
ビットマップを追加する場合、RGB カラー 0x0000FF00 (緑) は透明になっています。この値を使用する画像の全領域が透明になるため、[タスク一覧] は透過的に表示されます。
ビットマップの幅と高さは、16 × 16 ピクセルに設定する必要があります。
IPictureDisp を使用する場合は、PICTYPE 引数を Icon または Bitmap のいずれかに設定する必要があります。Metafiles、Uninitialized、または None を設定すると、正しく動作しません。
例
この例では、Add2 メソッドを使用して 2 つのタスク項目をタスク一覧に追加し、いくつかのタスク プロパティをメッセージ ボックスに表示します。このアドインの例を実行する方法の詳細については、「方法 : オートメーション オブジェクト モデルのコード例をコンパイルおよび実行する」を参照してください。
Imports EnvDTE
Imports EnvDTE80
Public Sub OnConnection(ByVal application As Object, _
ByVal connectMode As ext_ConnectMode, ByVal addInInst As Object, _
ByRef custom As Array) Implements IDTExtensibility2.OnConnection
_applicationObject = CType(application, DTE2)
_addInInstance = CType(addInInst, AddIn)
TaskItemsAdd2Example(_applicationObject)
End Sub
Sub TaskItemsAdd2Example(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 using Add2.
TLItem = TLItems.Add2(" ", " ", "Test task 1." _
, vsTaskPriority.vsTaskPriorityHigh, vsTaskIcon.vsTaskIconUser _
, True, , 10, , , False)
TLItem = TLItems.Add2(" ", " ", "Test task 2." _
, vsTaskPriority.vsTaskPriorityLow, vsTaskIcon.vsTaskIconComment _
, , , 20, , , False)
' 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 OnConnection(object application,
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
_applicationObject = (DTE2)application;
_addInInstance = (AddIn)addInInst;
TaskItems2Add2Example(_applicationObject);
}
public void TaskItems2Add2Example(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.Add2("MyTask", "MyTask1", "Test task 1."
, 1, vsTaskIcon.vsTaskIconUser, true,null,10,true,true,true);
TLItem = TLItems.Add2("MyTask", "MyTask1", "Test task 2."
, 2, vsTaskIcon.vsTaskIconComment, true, null, 20, true, true,false);
// 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);
}
アクセス許可
- 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。