TaskList.DefaultCommentToken - свойство

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает строку, которая используется по умолчанию для добавления задач в окно Список задач.

Пространство имен: EnvDTE
Сборка: EnvDTE (в EnvDTE.dll)

Синтаксис

'Декларация
ReadOnly Property DefaultCommentToken As String
'Применение
Dim instance As TaskList
Dim value As String

value = instance.DefaultCommentToken

string DefaultCommentToken { get; }

property String^ DefaultCommentToken {
    String^ get ();
}

function get DefaultCommentToken () : String

Значение свойства

Тип: System.String
Возвращает строку, которая используется по умолчанию для добавления задач в окно Список задач.

Заметки

Имеется возможность использовать маркеры примечаний для добавления задач в среду IDE Visual Studio. При вводе в исходном коде имени маркера в качестве примечания задача создается автоматически и добавляется к окну список задач.

Первый знак маркера должен быть первым буквенно-цифровым знаком в строке примечания. За маркером должен стоять хотя бы один знак пробела или знак, не относящийся к буквенно-цифровым знакам.

Например, можно добавить такую строку:

HACK: необходимо оптимизировать данный цикл.

Если HACK является допустимым маркером, строка добавляется к окну список задач как новый элемент задачи.

По умолчанию маркером примечания, возвращаемым данным свойством, является TODO; изменить его невозможно.

Примеры

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

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

TaskList Интерфейс

TaskList - члены

EnvDTE - пространство имен

Share via