TaskItems2.Add(String, String, String, vsTaskPriority, Object, Boolean, String, Int32, Boolean, Boolean) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Добавляет новый элемент задачи в 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
Необязательный параметр. Определяет тип значка, представляющего новый элемент задачи. Параметр должен иметь значение либо vsTaskIcon, либо IPictureDisp .
- Checkable
- Boolean
Необязательный параметр. Указывает, должен ли элемент задачи содержать флажок, который можно установить, чтобы отметить выполнение задачи. Значение по умолчанию — false.
- File
- String
Необязательный параметр. Указывает файл или путь, связанный с новым элементом задачи. Значением по умолчанию является пустая строка (""), и если она используется, то IsSettable[vsTaskListColumn](vsTaskListColumnFile) возвращает false. В качестве имени файла может использоваться полный путь, относительный путь или просто имя файла. Обратите внимание, что связывание файла или пути с элементом не обязательно означает, что он выполняет какие-то действия.
- Line
- Int32
Необязательный параметр. Указывает строку исходного кода, связанную с новым элементом задачи. Значением по умолчанию является 0, и если оно используется, то IsSettable[vsTaskListColumn](vsTaskListColumnLine) возвращает false. Обратите внимание, что связывание номера строки с элементом не обязательно означает, что он выполняет какие-то действия.
- CanUserDelete
- Boolean
Необязательный параметр. Указывает, можно ли удалять новый элемент задачи с помощью клавиши DELETE, когда элемент выделен в среде. Значение по умолчанию — true.
- FlushItem
- Boolean
Необязательный параметр. Указывает, отображается ли новый элемент сразу в список задач. Если флушитем имеет значение true , список задач обновляется сразу после Add вызова. Если флушитем имеет значение false , список задач обновляется позже после выполнения всех обновлений. falseПараметр используется в основном для повышения производительности при добавлении множества элементов в список задач. Значение по умолчанию — true.
Возвращаемое значение
Объект 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 аргумент пиктипе должен иметь значение Icon или Bitmap . Параметры Metafiles , Uninitialized или None не работают должным образом.