すべての FIELD XML 要素のリファレンス
更新 : 2011 年 1 月
このトピックの情報は、作業項目の種類のデータ フィールドを定義するすべての要素と主要な属性に関するクイック リファレンスとして使用できます。 これらの要素は、FIELD (定義) 要素コンテナーで指定します。 作業項目の種類にフィールドを追加するには、FIELDS (定義) 要素内に FIELD (定義) 要素を指定します。 これらの要素は、作業項目の種類の定義内で、またはグローバル ワークフローの一部として指定できます。 このトピックで説明している子要素を作成して、フィールドの動作の指定、既定値の定義、値の選択リストの定義などを実行できます。 フィールド規則の要素は要素同士を連携して使用できます。 ほとんどの規則は、1 つ以上のユーザーやグループに適用されるように指定したり、1 つ以上のユーザーやグループで無視されるようにすることができます。
注意
グローバル ワークフローを定義するには、アプリケーション層サーバーでこの機能を有効にする必要があります。 したがって、このサーバーでは、この機能をサポートする Visual Studio Team Foundation Server のバージョン (Team Foundation Server 2010 Service Pack 1 (SP1) など) が実行されている必要があります。 Service Pack は、Microsoft Web サイトの「Visual Studio Team Foundation Server 2010 SP1 Beta」からダウンロードできます。 詳細については、「グローバル ワークフローのカスタマイズ」を参照してください。
FIELD 要素のすべての子要素は省略できます。 HELPTEXT 要素を除き、すべての要素を FIELD (定義)、FIELD (ワークフロー)、および FIELD (グローバル ワークフロー) 要素の子要素として指定できます。 FIELD (定義) 要素を使用して、作業項目フィールドを定義し、そのフィールドに適用される規則および条件を指定します。 ある状態から別の状態に作業項目が遷移する場合に、フィールドの値を定義したり、規則をフィールドに適用したりするには、FIELD (ワークフロー) 要素の規則を指定します。 フィールド規則は、親 FIELDS 要素が子となる STATE 要素、TRANSITION 要素、DEFAULTREASON 要素、または REASON 要素に基づいて指定できます。 詳細については、「作業項目フィールドの使用」および「ワークフローのデザイン」を参照してください。
このトピックの内容
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 の子要素
次の表に、値をフィールドに割り当てるための規則を適用するときに指定できる子要素を示します。 すべての子要素が省略可能です。 ほとんどの子要素では、1 つのグループだけに、または 1 つのグループに属するユーザー以外の全員に適用するようにスコープを設定できます。
要素 |
説明と構文 |
---|---|
ALLOWEDVALUES |
ユーザーが作業項目フォームのフィールド リストおよびクエリ エディターで指定できる値のリストを定義します。 ユーザーは、このリストのいずれか 1 つの値を指定する必要があります。
詳細については、「選択リストの定義」を参照してください。 |
ALLOWEXISTINGVALUE |
値が選択リストからなくなった場合でも、既存の値をフィールドに残すことを指定します。 新しいフィールド値はすべてリストにある必要があります。
詳細については、「選択リストの定義」を参照してください。 |
CANNOTLOSEVALUE |
値を指定した後にユーザーがフィールドから値をクリアできないように指定します。 フィールドに値を格納した後は、NULL 以外の値を常にフィールドに格納する必要があります。
詳細については、「作業項目フィールドの条件の設定」を参照してください。 |
COPY |
ユーザーが作業項目を作成または変更するときに、指定された値をフィールドにコピーします。
詳細については、「既定値の定義またはフィールドへの値のコピー」を参照してください。 |
DEFAULT |
ユーザーが作業項目を作成または変更するときに、空のフィールドに値を指定します。 フィールドに既に値がある場合は、既定の規則は無視されます。
詳細については、「既定値の定義またはフィールドへの値のコピー」を参照してください。 |
EMPTY |
フィールドに格納されているすべての値をクリアします。 EMPTY 規則では、フィールドが読み取り専用としても設定されます。これを READONLY 規則と併用しないでください。 フィールド値はユーザーが作業項目を保存するときにクリアされますが、値を指定することはできません。 この規則は、項目の遷移先の状態を適用するフィールドをクリアするために状態遷移中に主に使用されます。
詳細については、「作業項目フィールドの条件の設定」を参照してください。 |
FROZEN |
変更がコミットされた後、フィールドを空でない値に変更できないように指定します。 ユーザーがこのフィールドの値を使用して作業項目を保存した後、フィールドの値を変更することはできません。
詳細については、「作業項目フィールドの条件の設定」を参照してください。 |
HELPTEXT |
ユーザーが作業項目フォームのフィールドをポイントするとテキストが表示されるように指定します。 tooltipText: 1 ~ 255 文字で構成されたテキスト文字列です。
詳細については、「作業項目フィールドに対するヘルプ テキストの定義」を参照してください。 |
MATCH |
文字列型フィールドの値が一致する必要があるパターンを定義します。
詳細については、「文字列フィールドとパターンの一致」を参照してください。 |
NOTSAMEAS |
別のフィールドに割り当てられている同じ値がフィールドに割り当てられないように指定します。 field 属性の値には、フィールドの有効な参照名を指定する必要があります。
詳細については、「作業項目フィールドの条件の設定」を参照してください。 |
PROHIBITEDVALUES |
フィールドに格納できない値のリストを定義します。 フィールドに禁止値が設定されている場合は、ユーザーは作業項目を保存できません。
詳細については、「選択リストの定義」を参照してください。 |
READONLY |
フィールドに割り当てられている値を変更できないように指定します。
メモ
この要素を EMPTY 要素と併用しないでください。EMPTY も、フィールドを読み取り専用に設定します。これらの要素を組み合わせると、矛盾した結果が生じます。
詳細については、「作業項目フィールドの条件の設定」を参照してください。 |
REQUIRED |
ユーザーがフィールドの値を指定する必要があるように指定します。 必須フィールドは空にできません。 ユーザーは、すべての必須フィールドに値を割り当てるまでは作業項目を保存できません。
詳細については、「作業項目フィールドの条件の設定」を参照してください。 |
SERVERDEFAULT |
ユーザーが作業項目を保存するときに、指定されたサーバー値をフィールドにコピーします。 通常これらのフィールドは、フォームには読み取り専用として表示されます。
詳細については、「既定値の定義またはフィールドへの値のコピー」を参照してください。 |
SUGGESTEDVALUES |
ユーザーが作業項目フォームのフィールド リストおよびクエリ エディターで指定できる推奨値のリストを定義します。 ユーザーは、推奨値以外の値を指定することもできます。
詳細については、「選択リストの定義」を参照してください。 |
VALIDUSER |
指定したグループに属するユーザーによる作業項目の変更を制限します。 既定のグループは Team Foundation 有効ユーザー グループです。 すべての属性は省略できます。 すべての属性は、1 ~ 255 文字のテキスト文字列で構成されている必要があります。 トークンを使用してグループを指定できます。 詳細については、「トークンによるユーザーとグループの参照」を参照してください。
詳細については、「作業項目を作成または変更するためのアクセス許可の管理」を参照してください。 |
WHEN |
別のフィールドが特定の値を持つときに現在のフィールドに適用する 1 つまたは複数の規則を指定します。 現在のフィールドは、親 FIELD 要素によって定義されます。
詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。 |
WHENNOT |
別のフィールドが特定の値ではないときに現在のフィールドに適用される 1 つ以上の規則を指定します。 現在のフィールドは、親 FIELD 要素によって定義されます。
詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。 |
WHENCHANGED |
作業項目のリビジョン中に別のフィールドが変更された場合に現在のフィールドに適用される 1 つ以上の規則を指定します。 現在のフィールドは、親 FIELD 要素によって定義されます。
詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。 |
WHENNOTCHANGED |
作業項目のリビジョン中に別のフィールドが変更されなかった場合に現在のフィールドに適用される 1 つ以上の規則を指定します。 現在のフィールドは、親要素によって定義されます。
詳細については、「条件付き値および条件付き規則の割り当て」を参照してください。 |
GLOBALLIST 子要素と LISTITEM 子要素
次の表に、GLOBALLIST 要素と LISTITEM 要素を示します。 これらの要素は、ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、および PROHIBITEDVALUES 要素の子要素として指定します。 これらの要素を使用して、ユーザーが指定できる項目の選択リストまたはドロップダウン メニューとして表示される値のリストを列挙できます。 詳細については、「リスト、選択リスト、およびグローバル リストの定義と使用」を参照してください。
要素 |
構文 |
説明 |
---|---|---|
GLOBALIST |
|
チーム プロジェクト コレクション用に保存され、コレクション内のすべてのチーム プロジェクトで使用できる一連の LISTITEM 要素を定義します。 globalListName: 1 ~ 255 文字で構成されたテキスト文字列です。 GLOBALLIST は、GLOBALLISTS 要素の必須の子要素であり、ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、および PROHIBITEDVALUES 要素の省略可能な子要素です。 グローバル リストは、作業項目の定義、グローバル リストの定義、またはグローバル ワークフロー内で定義できます。 |
LISTITEM |
|
有効なリスト値を定義します。 LISTITEM は、GLOBALLIST 要素の必須の子要素であり、ALLOWEDVALUES 要素、SUGGESTEDVALUES 要素、および PROHIBITEDVALUES 要素の省略可能な子要素です。 |
ページのトップへ
FIELD 子要素によって指定される属性
for 属性または not 属性を含めると、ほとんどの FIELD 規則を一連のグループまたはユーザーに適用するまたは適用しないように制限できます。 詳細については、「グループに対するフィールドの規則のスコープの限定」を参照してください。
属性 |
構文 |
説明 |
---|---|---|
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" |
必須。 値のコピー元または既定値の指定元となる値のソースを指定します。 有効な値は、次のとおりです。
"value" または "field" を指定する場合には、値またはフィールドの属性をそれぞれ含める必要があります。 |
field |
field="fieldReferenceName" |
省略可能。 field が from 属性に指定されている場合、フィールドにコピーされる値を持つフィールドの名前を指定します。 |
value |
value="valueToCopy" |
省略可能。 value が from 属性に指定されている場合、フィールドにコピーされる値を指定します。 |
ページのトップへ
参照
概念
その他の技術情報
履歴の変更
日付 |
履歴 |
理由 |
---|---|---|
2011 年 1 月 |
すべての FIELD 子要素の構文を提供し、削除されたトピックへのリンクを削除。 |
情報の拡充 |