TaskItems2.Add, méthode
Ajoute un nouvel élément à la TaskList.
Espace de noms : EnvDTE80
Assembly : EnvDTE80 (dans EnvDTE80.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 : StringObligatoire. Représente le nom de la catégorie de l'élément de tâche.
SubCategory
Type : StringObligatoire. Représente le nom de la sous-catégorie de l'élément de tâche.
Description
Type : StringObligatoire. Décrit l'élément de tâche.
Priority
Type : vsTaskPriorityOptionnel. Constante vsTaskPriority qui dénote la priorité de la tâche : haute, moyenne ou basse. Si la valeur est vsTaskPriorityHigh, une icône de point d'exclamation est affichée dans la première colonne de la Liste des tâches. Si la valeur est vsTaskPriorityMedium, rien n'est affiché. Si la valeur est vsTaskPriorityLow, une icône représentant une flèche vers le bas est affichée.
Icon
Type : ObjectOptionnel. 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 : BooleanOptionnel. 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 : StringOptionnel. 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 chemin d'accès complet, un 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 qu'il exécute des actions.
Line
Type : Int32Optionnel. 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 qu'il exécute des actions.
CanUserDelete
Type : BooleanOptionnel. 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 : BooleanOptionnel. Indique si un nouvel élément de tâche est immédiatement visible dans la Liste des tâches. Lorsque FlushItem est défini à true, la Liste des tâches est mise à jour immédiatement après l'appel de Add. Lorsque FlushItem est défini à false, la Liste des tâches est mise à jour lorsque toutes les mises à jour ont été faites. Un paramètre false est utilisé principalement pour améliorer les performances lorsque vous ajoutez de nombreux éléments à la fois dans la Liste des tâches. La valeur par défaut est true.
Valeur de retour
Type : TaskItem
Objet TaskItem.
Notes
Lors de l'ajout de bitmaps, la couleur RVB 0x0000FF00 (vert) est transparent. Tous les emplacements dans votre image qui utilisent cette valeur sont transparents et la Liste des tâches s'affiche à travers.
La largeur et la hauteur des bitmaps doivent être 16 x 16 pixels.
En cas d'utilisation de IPictureDisp, l'argument PICTYPE doit avoir la valeur Icon ou Bitmap. Les paramètres de Metafiles, Uninitialized ou None ne fonctionnent pas correctement.
Exemples
Cet exemple ajoute deux tâches à la liste des tâches et affiche certaines de leurs propriétés dans des boîtes de message. Pour plus d'informations sur l'exécution de cet exemple comme complément, consultez Comment : compiler et exécuter les exemples de code du modèle objet Automation.
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)
TaskItems2Example(_applicationObject)
End Sub
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 OnConnection(object application,
ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
_applicationObject = (DTE2)application;
_addInInstance = (AddIn)addInInst;
TaskItems2Example(_applicationObject);
}
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);
}
Sécurité .NET Framework
- Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.