所有 FIELD XML 項目參考

發行項
06/09/2015

本主題可用來查詢 FIELD 項目或其中一個子項目的語法。

您可以在 FIELD (定義) 項目容器中指定這些項目。在 FIELDS (定義) 項目中指定一個 FIELD (定義) 項目，即可為工作項目類型 (WIT) 加入一個欄位。您可以在 WIT 的定義中，或當做全域工作流程的一部分來指定這些項目。

您可以加入子項目，以指定欄位的行為、定義預設值，或定義值的挑選清單。這些欄位規則項目可相互搭配使用。您可以將大多數規則的範圍，限定為要套用至一個或多個使用者或群組，或針對一個或多個使用者或群組加以忽略。

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

定義當使用者指向工作項目表單中的欄位時所顯示的文字。

工具提示文字：包含 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 Valid Users 群組。

所有屬性都是選擇性的。所有屬性必須是由包含 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	定義一組為 Team 專案集合儲存，且集合中所有 Team 專案都可使用的 LISTITEM 項目。 `<GLOBALLIST name="globalListName"> <LISTITEM> . . . </LISTITEM> </GLOBALLIST>` globalListName：包含 1 到 255 個字元的文字字串。 GLOBALLIST 是 GLOBALLISTS 項目的必要子項目，是 ALLOWEDVALUES、SUGGESTEDVALUES 及 PROHIBITEDVALUES 項目的選用子項目。您可以在工作項目定義、全域清單定義或全域工作流程中，定義全域清單。
LISTITEM	定義有效的清單值。 `<LISTITEM value="listName" />` LISTITEM 是 GLOBALLIST 的必要子項目，是 ALLOWEDVALUES、SUGGESTEDVALUES 及 PROHIBITEDVALUES 項目的選用子項目。

項目

描述

GLOBALIST

定義一組為 Team 專案集合儲存，且集合中所有 Team 專案都可使用的 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 子項目指定的屬性

您可以包含 for 或 not 屬性，將大多數 FIELD 規則限定為要套用或不套用至一組群組或使用者。如需詳細資訊，請參閱套用欄位規則。

屬性	語法	描述
expanditems	expanditems="true \| false"	選擇項。指定 LISTITEM 項目所識別的群組是否應該擴展成包含清單中的附屬群組。此屬性的預設值為 true。
filteritems	filteritems="排除群組"	選擇項。指定淸單中只會包含群組的成員，而不會包含群組名稱。這個屬性的唯一允許值是 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" 欄位是空的，則不會執行任何動作。只有 <COPY> 和 <DEFAULT> 規則才會使用 field 屬性。 value：複製您指定之 value 屬性的值。使用您指定之字串常數的值。需要 value="abc" 屬性。只有 <COPY> 和 <DEFAULT> 規則才會使用 value。如果指定 "value" 或 "field"，也必須分別包含 value 或 field 屬性。
field	field="欄位參考名稱"	選擇項。指定為 from 屬性指定 field 時，要複製其值到欄位中的欄位名稱。
pattern	pattern="模式值"	必要項。只會對字串強制執行基本模式比對。模式值是由 1 到 255 個字元 (含) 所組成的字串。該字串不能包含反斜線字元 (\)。除非字串中的字元為下列六個中繼字元之一，否則字串中的每個字元都會解譯為常值： "A" 或 "a" 代表單一字母字元。 "N" 或 "n" 代表單一數字字元。 "X" 或 "x" 代表單一英數字元。模式值：^[^\\]*$ 例如，pattern="xxxxx.nn.nn" 會比對任何五個英數字元，後面接著點號和兩個數字字元，再接著另一個點號和兩個數字字元。
value	value="要複製的值"	選擇項。指定為 from 屬性指定 value 時，要複製到欄位中的值。

請參閱

概念

定義和修改工作項目欄位

變更工作項目類型的工作流程

共用方式為

所有 FIELD XML 項目參考

FIELD (定義) 容器項目

FIELD 子項目

GLOBALLIST 和 LISTITEM 子項目

由 FIELD 子項目指定的屬性

請參閱

概念

其他資源