Partager via

TaskItems.Add, méthode

  • Article

Ajoute un nouvel élément à la TaskList.

Espace de noms :  EnvDTE
Assembly :  EnvDTE (dans EnvDTE.dll)

Syntaxe

'Déclaration
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

Paramètres

  • Category
    Type : String

    Obligatoire. Représente le nom de la catégorie de l'élément de tâche.

  • SubCategory
    Type : String

    Obligatoire. Représente le nom de la sous-catégorie de l'élément de tâche.

  • Description
    Type : String

    Obligatoire. Décrit l'élément de tâche.

  • Icon
    Type : Object

    Optionnel. Détermine le type d'icône qui représente le nouvel élément de tâche. Ce paramètre doit être vsTaskIcon ou IPictureDisp.

  • Checkable
    Type : Boolean

    Optionnel. Indique si vous souhaitez que la tâche propose ou non une case à cocher que les utilisateurs peuvent activer pour indiquer que la tâche est effectuée. La valeur par défaut est false.

  • File
    Type : String

    Optionnel. Indique le fichier ou le chemin d'accès associé au nouvel élément de tâche. La valeur par défaut est une chaîne vide (""). Si elle est utilisée, IsSettable(vsTaskListColumnFile) retourne false. Le nom de fichier peut être un nom de chemin d'accès complet, un nom de chemin d'accès relatif ou simplement un nom de fichier. Notez qu'associer un fichier ou un chemin d'accès à un élément ne signifie pas nécessairement que ce dernier exécutera des actions.

  • Line
    Type : Int32

    Optionnel. Indique la ligne dans le code source associée au nouvel élément de tâche. La valeur par défaut est 0. Si elle est utilisée, IsSettable(vsTaskListColumnLine) retourne false. Notez qu'associer un numéro de ligne à un élément ne signifie pas nécessairement que ce dernier exécutera des actions.

  • CanUserDelete
    Type : Boolean

    Optionnel. Indique si un utilisateur peut supprimer le nouvel élément de tâche en appuyant sur SUPPR lorsque l'élément est sélectionné dans l'environnement. La valeur par défaut est true.

  • FlushItem
    Type : Boolean

    Optionnel. Indique si un nouvel élément de tâche est immédiatement visible dans la Liste des tâches. Lorsque FlushItem a la valeur True, la liste des tâches est mise à jour immédiatement après que la méthode Add a été appelée. Lorsque FlushItem a la valeur false, la liste des tâches est mise à jour ultérieurement, après que toutes les mises à jour ont été faites. À l'origine, un paramètre false est utilisé pour améliorer les performances lorsque vous ajoutez un grand nombre d'éléments à la liste des tâches en une seule fois. La valeur par défaut est true.

Valeur de retour

Type : EnvDTE.TaskItem
Objet TaskItem.

Notes

Lors de l'ajout de bitmaps, la couleur RVB 0x0000FF00 (vert) est transparent. Tous les emplacements de votre image qui utilisent cette valeur seront transparents et la liste des tâches s'affichera à travers.

La largeur et la hauteur des bitmaps doivent être 16 x 16 pixels.

Si vous utilisez IPictureDisp, l'argument PICTYPE doit être défini à Icon ou Bitmap. Les paramètres de Metafiles, Uninitialized ou None ne fonctionneront pas correctement.

Exemples

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

Sécurité .NET Framework

Voir aussi

Référence

TaskItems Interface

EnvDTE, espace de noms