TaskList.DefaultCommentToken Property
Gets the default string for adding tasks to the Task List window.
Namespace: EnvDTE
Assembly: EnvDTE (in EnvDTE.dll)
Syntax
'Declaration
ReadOnly Property DefaultCommentToken As String
'Usage
Dim instance As TaskList
Dim value As String
value = instance.DefaultCommentToken
string DefaultCommentToken { get; }
property String^ DefaultCommentToken {
String^ get ();
}
function get DefaultCommentToken () : String
Property Value
Type: System.String
The default string for adding tasks to the Task List window.
Remarks
You can use comment tokens to add tasks to your Visual Studio integrated development environment (IDE). By entering that token name as a remark in your code, a task is automatically created and added to the Task List window.
The first character of a token must be the first alphanumeric character in the comment line. The token must be followed by at least one white space character or nonalphanumeric character.
For example, you might add this line:
'HACK: Need to optimize this loop.
If "HACK" is a valid token, the string is added to the Task List window as a new task item.
The default comment token, returned by this property, is "TODO" and cannot be changed.
Examples
Sub DefaultCommentTokenExample()
' Before running, add a task to the Task List.
Dim win As Window = DTE.Windows.Item(Constants.vsWindowKindTaskList)
Dim TL As TaskList = win.Object
Dim TLItem As TaskItem = TL.TaskItems.Item(1)
Dim msg As String
' List properties of the Task Item.
msg = "TaskItem Category property value: " & TLItem.Category & vbCr
msg = msg & "TaskItem SubCategory property value: " & TLItem.SubCategory & vbCr
msg = msg & "TaskItem DefaultCommentToken property value: " & TL.DefaultCommentToken & vbCr
msg = msg & "TaskItem Checked property value: " & TLItem.Checked & vbCr
msg = msg & "TaskItem Displayed property value: " & TLItem.Displayed & vbCr
msg = msg & "TaskItem IsSettable property value: " & TLItem.IsSettable(vsTaskListColumn.vsTaskListColumnCheck) & vbCr
msg = msg & "TaskItem Priority property value: " & TLItem.Priority & vbCr
MsgBox(msg)
End Sub
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.