Поделиться через

All FIELD XML elements reference

  • Статья

Используйте этот раздел, чтобы разобраться в синтаксисе элемента FIELD или одного из его дочерних элементов.

Эти элементы указываются в контейнере элементов FIELD (определение). Вы добавляете поле для типа рабочих элементов, указав элемент FIELD (определение) внутри элемента FIELDS (определение). Эти элементы можно задать внутри определения типа рабочих элементов либо в рамках глобального рабочего процесса.

Вы можете добавить дочерние элементы, чтобы задать поведение поля, определить значения по умолчанию или список выбора значений. Элементы правил поля можно использовать совместно друг с другом. Для большинства правил можно задать область действия, в которой будет применяться правило, включая и исключая отдельных пользователей или целые группы.

Элемент-контейнер FIELD (определение)

Чтобы определить поля данных для типа рабочих элементов, используйте следующий синтаксис. В примере показан формат элемента FIELD (определение) и всех дополнительных дочерних элементов. Дополнительные сведения см. в разделе FIELD (Definition) element reference.

<FIELD name="fieldDisplayName" refname="fieldReferenceName" type="String | Integer | Double | DateTime | PlainText | HTML | History | TreePath | GUID "
syncnamechanges="true | false" reportingname="reportingDisplayName" reportingrefname="reportingReferenceName"
reportable="Dimension | Detail | Measure" formula="avg" >
   <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
   <ALLOWEXISTINGVALUE />
   <CANNOTLOSEVALUE />
   <COPY />
   <DEFAULT />
   <EMPTY />
   <FROZEN />
   <HELPTEXT> . . . </HELPTEXT>
   <MATCH />
   <NOTSAMEAS />
   <PROHIBITEDVALUES /> . . . </PROHIBITEDVALUES>
   <READONLY />
   <REQUIRED />
   <SERVERDEFAULT />
   <SUGGESTEDVALUES /> . . . </SUGGESTEDVALUES>
   <VALIDUSER />
   <WHEN>> . . . </WHEN>
   <WHENNOT> . . . </WHENNOT>
   <WHENCHANGED> . . . </WHENCHANGED>
   <WHENNOTCHANGED> . . . </WHENNOTCHANGED>
</FIELD>

Дочерние элементы FIELD

Используйте дочерние элементы, чтобы задать различные ограничения для вводимых в поле данных. Можно указать значения для списка выбора (раскрывающееся меню), задать значения по умолчанию, очистить записи или ограничить внесение изменений. В следующей таблице приведена структура синтаксиса для каждого дочернего элемента.

Чтобы узнать, как использовать эти элементы, см. раздел Применение правила к полю рабочего элемента. Для большинства правил ограничивается применение к системным полям. Все дочерние элементы являются необязательными.

Элемент

Описание и синтаксис

ALLOWEDVALUES

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

<ALLOWEDVALUES for="userGroupName" not="userGroupName" 
expanditems="true | false" filteritems="excludegroups">
   <GLOBALLIST name="globalListName">
      <LISTITEM value="Name" />
. . . 
   </GLOBALLIST>
</ALLOWEDVALUES>

Дополнительные сведения см. в разделе Определение списков выбора.

ALLOWEXISTINGVALUE

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

<ALLOWEXISTINGVALUE />

Дополнительные сведения см. в разделе Определение списков выбора.

CANNOTLOSEVALUE

Указывает, что пользователи не могут очистить поле от всех значений после задания значения. После получения значения поле всегда должно содержать значение, отличное от NULL.

<CANNOTLOSEVALUE for="userGroupName" not="userGroupName" />

Дополнительные сведения см. в разделе Применение правила поля.

COPY

Копирует указанное значение в поле, когда пользователь создает или изменяет рабочий элемент.

<COPY for="userGroupName" not="userGroupName"  
from="value | field | clock | currentuser" 
value="valueToCopy" field="fieldReferenceName" />

Дополнительные сведения см. в разделе Определение значения по умолчанию или копирование значения в поле.

DEFAULT

Задает значение для поля, которое пусто во время создания или изменения рабочего элемента пользователем. Если поле уже содержит значение, это правило по умолчанию игнорируется.

<DEFAULT for="userGroupName" not="userGroupName" 
from="value | field | clock | currentuser" 
value="value to copy" field="field reference name" />

Дополнительные сведения см. в разделе Определение значения по умолчанию или копирование значения в поле.

EMPTY

Очищает поле от любого содержащегося в нем значения. Правило EMPTY также делает поле доступным только для чтения, поэтому его не следует использовать совместно с правилом READONLY.

Значение поля очищается, когда пользователь сохраняет рабочий элемент, и вы не можете задать никакое значение. Это правило используется в основном во время перехода между состояниями и служит для очистки полей, применяемых к состоянию, в которое переходит элемент.

<EMPTY for="userGroupName" not=" userGroupName" />

Дополнительные сведения см. в разделе Применение правила поля.

FROZEN

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

<FROZEN for="userGroupName" not="userGroupName" />

Дополнительные сведения см. в разделе Применение правила поля.

HELPTEXT

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

tooltipText: текстовая строка длиной от 1 до 255 символов.

<HELPTEXT>tooltipText </HELPTEXT>

Дополнительные сведения см. в разделе Применение правила поля.

MATCH

Определяет шаблон, которому должны соответствовать значения полей строкового типа.

<MATCH pattern="patternValue" for="userGroupName" not="userGroupName" />

Дополнительные сведения см. в разделе Применение сопоставления шаблона к строковому полю.

NOTSAMEAS

Указывает, что полю не назначается то же самое значение, которое назначено другому полю. Значение атрибута field должно быть действительным именем ссылки поля.

<NOTSAMEAS field="fieldReferenceName" for="userGroupName" not="userGroupName" />

Дополнительные сведения см. в разделе Применение правила поля.

PROHIBITEDVALUES

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

<PROHIBITEDVALUES for="userGroupName" not="userGroupName" 
expanditems="true | false" filteritems="excludegroups">
   <GLOBALLIST name="globalListName">
      <LISTITEM value="Name" />
. . . 
   </GLOBALLIST>
</PROHIBITEDVALUES>

Дополнительные сведения см. в разделе Определение списков выбора.

READONLY

Указывает, что вы не можете изменить присвоенное полю значение.

<READONLY for="userGroupName" not="userGroupName" />

Примечание

Не используйте этот элемент совместно с элементом EMPTY, так как EMPTY также делает поле доступным только для чтения.Совместное использование этих элементов дает несогласованные результаты.

Дополнительные сведения см. в разделе Применение правила поля.

REQUIRED

Указывает, что пользователи должны задать значение для поля. Обязательные к заполнению поля не могут быть пустыми. Пользователи не могут сохранить рабочий элемент, пока не назначат значения всем обязательным полям.

<REQUIRED for="userGroupName" not="userGroupName" />

Дополнительные сведения см. в разделе Применение правила поля.

SERVERDEFAULT

Копирует указанное значение сервера в поле, когда пользователь сохраняет рабочий элемент. На форме эти поля обычно доступны только для чтения.

<SERVERDEFAULT for="userGroupName" not="userGroupName" 
from="clock | currentuser" />

Дополнительные сведения см. в разделе Определение значения по умолчанию или копирование значения в поле.

SUGGESTEDVALUES

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

<SUGGESTEDVALUES for="userGroupName" not="userGroupName" 
expanditems="true | false" filteritems="excludegroups">
   <GLOBALLIST name="globalListName">
      <LISTITEM value="Name" />
. . . 
   </GLOBALLIST>    
</SUGGESTEDVALUES>

Дополнительные сведения см. в разделе Определение списков выбора.

VALIDUSER

Ограничивает изменение рабочих элементов пользователями, принадлежащими к указанной вами группе. По умолчанию используется группа «Допустимые пользователи Team Foundation».

Все атрибуты являются необязательными и должны состоять из текстовой строки длиной от 1 до 255 символов. Для указания групп можно использовать токены.

< VALIDUSER group="groupName" for="userName" not="userName" />

Дополнительные сведения см. в разделе Применение правила поля.

WHEN

Задает одно или несколько правил, применяемых к текущему полю, если другое поле имеет определенное значение. Родительский элемент FIELD определяет текущее поле.

<WHEN field="fieldReferenceName" value="value">
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>
</WHEN>

Дополнительные сведения см. в разделе Назначение условных значений и правил.

WHENNOT

Задает одно или несколько правил, применяемых к текущему полю, если другое поле не имеет определенного значения. Родительский элемент FIELD определяет текущее поле.

<WHENNOT field="fieldReferenceName" value="value">
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>
</WHENNOT>

Дополнительные сведения см. в разделе Назначение условных значений и правил.

WHENCHANGED

Задает одно или несколько правил, применяемых к текущему полю, когда другое поле изменяется во время исправления рабочего элемента. Родительский элемент FIELD определяет текущее поле.

<WHENCHANGED field="fieldReferenceName" >
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>      
</WHENCHANGED>

Дополнительные сведения см. в разделе Назначение условных значений и правил.

WHENNOTCHANGED

Задает одно или несколько правил, применяемых к текущему полю, когда другое поле не изменяется во время исправления рабочего элемента. Родительский элемент определяет текущее поле.

<WHENNOTCHANGED field="fieldReferenceName">
    <ALLOWEDVALUES> . . . </ALLOWEDVALUES>
    <ALLOWEXISTINGVALUE> . . . <ALLOWEXISTINGVALUE>
    <CANNOTLOSEVALUE> . . . </CANNOTLOSEVALUE>
    <COPY> . . . </COPY>
    <DEFAULT> . . . </DEFAULT>
    <EMPTY> . . . </EMPTY>
    <FROZEN> . . . </FROZEN>
    <MATCH> . . . </MATCH>
    <NOTSAMEAS> . . . </NOTSAMEAS>
    <PROHIBITEDVALUES> . . . </PROHIBITEDVALUES>
    <READONLY> . . . </READONLY>
    <REQUIRED> . . . </REQUIRED>
    <SERVERDEFAULT> . . . </SERVERDEFAULT>        
    <SUGGESTEDVALUES> . . . </SUGGESTEDVALUES>
    <VALIDUSER> . . . </VALIDUSER>
</WHENNOTCHANGED>

Дополнительные сведения см. в разделе Назначение условных значений и правил.

Дочерние элементы GLOBALLIST и LISTITEM

Элементы GLOBALLIST и LISTITEM указываются как дочерние по отношению к элементам ALLOWEDVALUES, SUGGESTEDVALUES и PROHIBITEDVALUES. Их можно использовать для перечисления отображаемого списка значений. Пользователи выбирают значения в списке выбора или в раскрывающемся меню. Дополнительные сведения см. в разделе Define global lists.

Элемент

Описание

GLOBALIST

Определяет набор элементов LISTITEM, хранимых для коллекции командных проектов, которые могут использовать все командные проекты в этой коллекции.

<GLOBALLIST name="globalListName">
    <LISTITEM> . . . </LISTITEM>
</GLOBALLIST>

globalListName— текстовая строка длиной от 1 до 255 символов.

GLOBALLIST— это обязательный дочерний элемент элемента GLOBALLISTS и необязательный дочерний элемент элементов ALLOWEDVALUES, SUGGESTEDVALUES и PROHIBITEDVALUES. Можно определить глобальный список в определении рабочего элемента, определении глобального списка или глобальном рабочем процессе.

LISTITEM

Определяет допустимое значение списка.

<LISTITEM value="listName" />

LISTITEM— это обязательный дочерний элемент элемента GLOBALLIST и необязательный дочерний элемент элементов ALLOWEDVALUES, SUGGESTEDVALUES и PROHIBITEDVALUES.

Атрибуты, заданные дочерними элементами FIELD

Для большинства правил FIELD можно разрешить или запретить применение к определенному набору пользователей или групп с помощью добавления атрибутов for или not. Дополнительные сведения см. в разделе Применение правила поля.

Атрибут

Синтаксис

Описание

expanditems

expanditems="true | false"

Необязательно. Указывает, следует ли расширить указанную элементом LISTITEM группу для включения подчиненных групп в список. Значение данного атрибута по умолчанию — true.

filteritems

filteritems="excludegroups"

Необязательно. Указывает, что в список включаются только члены групп, а имена групп не включаются. Этот атрибут может иметь единственное значение — excludegroups.

for

for="userGroupName"

Необязательно. Указывает имя пользователя или группы в Team Foundation, к которым применяется правило. Допустимые значения состоят из текстовой строки длиной от 1 до 255 символов.

not

not="userGroupName"

Необязательно. Указывает имя пользователя или группы в Team Foundation, к которым правило не применяется. Допустимые значения состоят из текстовой строки длиной от 1 до 255 символов.

from

from="value | field | clock | currentuser"

Обязательный. Указывает источник значения, из которого следует скопировать значение или задать значение по умолчанию. Допустимы следующие значения.

  • clock:   копирует текущую дату и время из системных часов в поле DateTime. Дополнительные атрибуты не требуются. Для правил COPY и DEFAULT это значение получается из часов локального компьютера. Для SERVERDEFAULT значение получается из часов сервера, когда пользователь сохраняет рабочий элемент.

  • currentuser: копирует имя пользователя, который выполнил вход в систему в данный момент. Используйте в качестве значения краткое имя текущего пользователя. Дополнительные атрибуты не требуются. Используется для полей строк.

  • field: копирует значение указанного вами атрибута field. Необходим атрибут field="abc". По умолчанию, если заданное поле «from» пусто, никакое действие не выполняется. Атрибут field используется только для правил <COPY> и <DEFAULT>.

  • value: копирует значение указанного вами атрибута value. Используйте значение указанной строковой константы. Необходим атрибут value="abc". value используется только для правил <COPY> и <DEFAULT>.

Если указан «value» или «field», необходимо задать соответственно и атрибут значения или поля.

field

field="fieldReferenceName"

Необязательно. Указывает имя поля, значение которого требуется скопировать в данное поле при указании значения field для атрибута from.

pattern

pattern="patternValue"

Обязательный. Применяет базовое сопоставление шаблонов только для строк. patternValue — это строка длиной от 1 до 255 знаков включительно, которая не должна содержать символ обратной косой черты (\). Каждый символ в строке интерпретируется как литерал, если только он не является одним из шести метасимволов:

  • «A» или «a» представляет отдельный алфавитный символ.

  • «N» или «n» представляет отдельный числовой символ.

  • «X» или «x» представляет отдельный буквенно-цифровой символ.

Значение шаблона: ^[^\\]*$

Например, pattern="xxxxx.nn.nn" соответствует пяти любым буквенно-цифровым символам, после которых идет точка, два числовых символа, затем точка и еще два числовых символа.

value

value="valueToCopy"

Необязательно. Указывает значение, которое требуется скопировать в поле при указании значения value для атрибута from.

См. также

Основные понятия

Определение и изменение полей рабочих элементов

Change the workflow for a work item type