TaskItems2.Add-Methode

Fügt der TaskList ein neues Aufgabenelement hinzu.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
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

Parameter

• Category
  Typ: String

  Erforderlich. Stellt den Kategorienamen des neuen Aufgabenelements dar.

• SubCategory
  Typ: String

  Erforderlich. Stellt den Namen der Unterkategorie des Aufgabenelements dar.

• Description
  Typ: String

  Erforderlich. Beschreibt das Aufgabenelement.

• Priority
  Typ: vsTaskPriority

  Optional. Eine vsTaskPriority-Konstante zeigt die Priorität des Aufgabenelements an: hoch, mittel oder niedrig. Wenn der Wert vsTaskPriorityHigh ist, wird in der ersten Spalte der Aufgabenliste ein Symbol mit Ausrufezeichen angezeigt. Wenn der Wert vsTaskPriorityMedium ist, wird kein besonderes Symbol angezeigt. Wenn der Wert vsTaskPriorityLow ist, wird ein Symbol mit einem Pfeil nach unten angezeigt.

• Icon
  Typ: Object

  Optional. Bestimmt den Symboltyp für das neue Aufgabenelement. Als Einstellung muss entweder vsTaskIcon oder IPictureDisp gewählt werden.

• Checkable
  Typ: Boolean

  Optional. Gibt an, ob zu dem Aufgabenelement ein Kontrollkästchen bereitgestellt wird, das der Benutzer bei Abschluss einer Aufgabe aktivieren kann. Der Standardwert ist false.

• File
  Typ: String

  Optional. Gibt die Datei bzw. den Pfad an, der dem neuen Aufgabenelement zugeordnet ist. Als Standardwert wird eine leere Zeichenfolge ("") verwendet. Bei leerer Zeichenfolge gibt IsSettable(vsTaskListColumnFile) den Wert false zurück. Der Dateiname kann als vollständiger Pfad, relativer Pfad oder einfacher Dateiname angegeben sein. Wenn Sie einem Element eine Datei oder einen Pfad zuordnen, werden dadurch noch nicht zwangsläufig Aktionen ausgelöst.

• Line
  Typ: Int32

  Optional. Gibt die Zeile im Quellcode zurück, der dem neuen Aufgabenelement zugeordnet ist. Als Standardwert wird 0 verwendet. Bei Verwendung von 0 gibt IsSettable(vsTaskListColumnLine) den Wert false zurück. Wenn Sie einem Element eine Zeilennummer zuordnen, werden dadurch noch nicht zwangsläufig Aktionen ausgelöst.

• CanUserDelete
  Typ: Boolean

  Optional. Zeigt an, ob ein Benutzer das neue Aufgabenelement mit der ENTF-TASTE löschen kann, wenn das Element in der Umgebung ausgewählt ist. Der Standardwert ist true.

• FlushItem
  Typ: Boolean

  Optional. Gibt an, ob ein neues Element in der Aufgabenliste sofort sichtbar ist. Wenn FlushItem auf true festgelegt ist, wird die Aufgabenliste sofort nach Aufruf von Add aktualisiert. Wenn FlushItem auf false festgelegt ist, wird die Aufgabenliste erst aktualisiert, nachdem alle anderen Aktualisierungen vorgenommen wurden. Die Festlegung false dient vorwiegend dazu, die Leistung zu verbessern, insbesondere wenn der Aufgabenliste mehrere Elemente gleichzeitig hinzugefügt werden sollen. Der Standardwert ist true.

Rückgabewert

Typ: TaskItem
Ein TaskItem-Objekt.

Hinweise

Beim Hinzufügen von Bitmaps wird die RGB-Farbe 0x0000FF00 (Grün) transparent dargestellt. Alle Bereiche im Bild, die diesen Wert aufweisen, werden durchsichtig angezeigt, sodass die Aufgabenliste durchscheint.

Die Breite und Höhe von Bitmaps muss 16 x 16 Pixel betragen.

Bei IPictureDisp muss das PICTYPE-Argument auf Icon oder Bitmap festgelegt werden. Die Einstellungen von Metafiles, Uninitialized oder None können nicht ordnungsgemäß ausgeführt werden.

Beispiele

In diesem Beispiel werden der Aufgabenliste zwei Aufgabenelemente hinzugefügt und einige der zugehörigen Eigenschaften in Meldungsfenstern angezeigt. Weitere Informationen zum Ausführen dieses Beispiels als Add-In finden Sie unter Gewusst wie: Kompilieren und Ausführen der Codebeispiele für das Automatisierungsobjektmodell.

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);
}

.NET Framework-Sicherheit

• Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

TaskItems2 Schnittstelle

EnvDTE80-Namespace