Справка по всем XML-элементам FIELD

Статья
03/12/2013

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

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

Содержание раздела

Элемент-контейнер FIELD (определение)
Дочерние элементы FIELD
Дочерние элементы GLOBALLIST и LISTITEM
Атрибуты, определяемые дочерними элементами FIELD

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

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

<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.Эти элементы можно использовать для перечисления списка значений, из которых пользователь может выбирать с помощью списка выбора или в раскрывающегося меню.Дополнительные сведения см. в разделе Определение пользовательских списков, списков выбора и глобальных списков.

Элемент	Синтаксис	Описание
GLOBALIST	`<GLOBALLIST name="globalListName "> <LISTITEM> . . . </LISTITEM> </GLOBALLIST>`	Определяет набор элементов LISTITEM, который сохранен для коллекции командных проектов и может использоваться во всех командных проектах коллекции. globalListName. Текстовая строка длиной от 1 до 255 знаков. GLOBALLIST является обязательным дочерним элементом элемента GLOBALLISTS и необязательным дочерним элементом элементов ALLOWEDVALUES, SUGGESTEDVALUES и PROHIBITEDVALUES.Глобальный список можно определить в определении рабочего элемента, определении глобального списка или в глобальном рабочем процессе.
LISTITEM	`<LISTITEM value="listName" />`	Определяет допустимое значение элемента списка. LISTITEM является обязательным дочерним элементом элемента GLOBALLIST и необязательным дочерним элементом элементов ALLOWEDVALUES, SUGGESTEDVALUES и PROHIBITEDVALUES.

Элемент

Синтаксис

Описание

GLOBALIST

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

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

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="имя_группы_или_пользователя"	Необязательный параметр.Задает имя пользователя или группы Team Foundation, к которым применяется данное правило.Допустимые значения представляют собой текстовую строку длиной от 1 до 255 знаков.
not	not="имя_группы_или_пользователя"	Необязательный параметр.Задает имя пользователя или группы Team Foundation, к которым данное правило не применяется.Допустимые значения представляют собой текстовую строку длиной от 1 до 255 знаков.
from	from="value \| field \| clock \| currentuser"	Обязательное.Указывает источник, из которого необходимо скопировать значение или взять значение по умолчанию.Допустимы следующие значения. clock: Копирует текущие дата и время из системных часов к полям даты и времени. Дополнительные атрибуты не требуются.Для правил COPY и DEFAULT значение берется из часов локального компьютера.Для правила SERVERDEFAULT значение определяется по серверным часам в момент сохранения рабочего элемента пользователем. currentuser. Копирует имя находящегося в системе пользователя.В качестве значения следует использовать короткое имя текущего пользователя.Дополнительные атрибуты не требуются.Используется для строковых полей. field. Копирует значение указанного атрибута field.Требуется атрибут field="abc".По умолчанию, если указанное поле "from" пусто, ничего не выполняется.Атрибут field используется только для правил <COPY> и <DEFAULT>. value. Копирует значение указанного атрибута value.Используется значение из указанной строковой константы.Требуется атрибут value="abc".value используется только для правил <COPY> и <DEFAULT>. Если указывается значение "value" или "field", необходимо также включить атрибут "value" или "field" соответственно.
field	field="ссылочное_имя_поля"	Необязательный параметр.Задает имя поля, значение которого должно быть скопировано в поле, если в качестве атрибута from задано значение field.
pattern	pattern= "patternValue"	Обязательное.Следит за соответствием строк основным шаблонам.patternValue - строка, состоящая из диапазона от 1 до 255 символов, включительная.Эта строка не должна содержать косую черту (\).Каждый символ в строке интерпретируется как литерал, если он не является один из следующих 6: метасимволы "A" или "a" представляют собой единый алфавитный знак. "N" или "n" представляет одну цифру. "X" или "x" представляют один алфавитно-цифровой символ. Значение шаблона: ^[^\\]*$ Например, выражение pattern="xxxxx.nn.nn" соответствует всем символам алфавитно-цифровым 5, затем точки, затем 2 цифр, затем точки, затем более 2 цифр.
value	value="копируемое_значение"	Необязательный параметр.Задает значение, которое должно быть скопировано в поле, если в качестве атрибута from задано значение value.

К началу

См. также

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

Определение пользовательских списков, списков выбора и глобальных списков

Работа с полями рабочих элементов

Разработка рабочего процесса

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