TaskItems.Add - метод

Статья
11/01/2012

Добавляет новый элемент задачи в 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

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

TaskItems Интерфейс

EnvDTE - пространство имен

Поделиться через