TaskItems.Add Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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)]
public EnvDTE.TaskItem Add (string Category, string SubCategory, string Description, EnvDTE.vsTaskPriority Priority, 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.TaskItemPublic 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 TaskItemPublic Function Add (Category As String, SubCategory As String, Description As String, Priority As vsTaskPriority, 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 TaskItemParameters
- Category
- String
Required. Represents the category name of the task item.
- SubCategory
- String
Required. Represents the subcategory name of the task item.
- Description
- String
Required. Describes the task item.
- Priority
- vsTaskPriority
Optional. A vsTaskPriority constant denoting the priority of the task item (high, medium, or low). If the value is vsTaskPriorityHigh, an exclamation point icon is displayed in the first column of the Task List. If the value is vsTaskPriorityMedium, nothing is displayed. If the value is vsTaskPriorityLow, a down arrow icon is displayed.
- Icon
- Object
Optional. Determines the type of icon that represents the new task item. The setting must be either vsTaskIcon or an IPictureDisp.
- Checkable
- Boolean
Optional. Indicates whether or not you want the task item to provide a checkbox that users can check to indicate the task is complete. The default value is false.
- File
- String
Optional. Indicates the file or path associated with the new task item. The default value is an empty string (""), and if this is used, IsSettable[vsTaskListColumn](vsTaskListColumnFile) returns false. The file name can be a full path name, a relative path name, or simply a file name. Note that associating a file or path with an item does not necessarily mean that it will perform any actions.
- Line
- Int32
Optional. Indicates the line in the source code associated with the new task item. The default value is 0, and if this is used, IsSettable[vsTaskListColumn](vsTaskListColumnLine) returns false. Note that associating a line number with an item does not necessarily mean that it will perform any actions.
- CanUserDelete
- Boolean
Optional. Indicates whether a user can delete the new task item by pressing DELETE when the item is selected in the environment. The default value is true.
- FlushItem
- Boolean
Optional. Indicates whether a new item is immediately visible in the Task List. When FlushItem is set to True, the Task List is updated immediately after Add is called. When FlushItem is set to false, the Task List is updated later after all updates are made. A false setting is used primarily to enhance performance when you are adding a large number of items at a time to the Task List. The default value is true.
Returns
A TaskItem object.
- Attributes
Remarks
The Priority defaults to vsTaskPriorityMedium in IDL but we can't default it here as the Icon cannot be defaulted