Sdílet prostřednictvím

TaskItems.Add-Methode

  • Článek

Aktualisiert: November 2007

Fügt der TaskList ein neues Aufgabenelement hinzu.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.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
'Usage
Dim instance As TaskItems
Dim Category As String
Dim SubCategory As String
Dim Description As String
Dim Priority As vsTaskPriority
Dim Icon As Object
Dim Checkable As Boolean
Dim File As String
Dim Line As Integer
Dim CanUserDelete As Boolean
Dim FlushItem As Boolean
Dim returnValue As TaskItem

returnValue = instance.Add(Category, SubCategory, _
    Description, Priority, Icon, Checkable, _
    File, Line, CanUserDelete, FlushItem)

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
)

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: System.String

    Erforderlich. Stellt den Kategorienamen des neuen Aufgabenelements dar.

  • SubCategory
    Typ: System.String

    Erforderlich. Stellt den Namen der Unterkategorie des Aufgabenelements dar.

  • Description
    Typ: System.String

    Erforderlich. Beschreibt das Aufgabenelement.

  • Icon
    Typ: System.Object

    Optional. Bestimmt den Symboltyp für das neue Aufgabenelement. Die Einstellung muss vsTaskIcon oder IPictureDisp lauten.

  • Checkable
    Typ: System.Boolean

    Optional. Gibt an, ob für das Aufgabenelement ein Kontrollkästchen angezeigt werden soll. Dieses kann vom Benutzer aktiviert werden, nachdem er die Aufgabe abgeschlossen hat. Der Standardwert ist false.

  • File
    Typ: System.String

    Optional. Gibt die Datei bzw. den Pfad an, der dem neuen Aufgabenelement zugeordnet ist. Der Standardwert ist eine leere Zeichenfolge (""). Falls er verwendet wird, gibt IsSettable(vsTaskListColumnFile) den Wert false zurück. Der Dateiname kann ein vollständiger Pfad, ein relativer Pfad oder ein einfacher Dateiname sein. Auch wenn einem Element eine Datei oder ein Pfad zugeordnet wurde, bedeutet dies nicht, dass Vorgänge irgendwelcher Art ausgeführt werden.

  • Line
    Typ: System.Int32

    Optional. Gibt die Zeile im Quellcode zurück, der dem neuen Aufgabenelement zugeordnet ist. Der Standardwert ist 0. Falls er verwendet wird, gibt IsSettable(vsTaskListColumnLine) den Wert false zurück. Auch wenn einem Element eine Zeilennummer zugeordnet wurde, bedeutet dies nicht, dass Vorgänge irgendwelcher Art ausgeführt werden.

  • CanUserDelete
    Typ: System.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: System.Boolean

    Optional. Gibt an, ob ein neues Element sofort in der Aufgabenliste sichtbar ist. Wenn FlushItem auf True festgelegt wurde, wird die Aufgabenliste sofort nach dem Aufruf von Add aktualisiert. Wenn FlushItem auf false festgelegt wurde, wird die Aufgabenliste erst aktualisiert, nachdem alle anderen Aktualisierungen ausgeführt wurden. Die Einstellung false wird hauptsächlich zur Leistungssteigerung verwendet, wenn der Aufgabenliste eine große Anzahl von Elementen gleichzeitig hinzugefügt wird. Der Standardwert ist true.

Rückgabewert

Typ: EnvDTE.TaskItem

Ein TaskItem-Objekt.

Hinweise

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

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

Wenn IPictureDisp verwendet wird, muss das PICTYPE-Argument auf Icon oder Bitmap festgelegt werden. Die Einstellungen Metafiles, Uninitialized oder None funktionieren nicht ordnungsgemäß.

Beispiele

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

Berechtigungen

Siehe auch

Referenz

TaskItems-Schnittstelle

TaskItems-Member

EnvDTE-Namespace