すべての FORM XML 要素のリファレンス
このトピックの情報は、作業項目の種類のフォームを制御するすべての要素と主要な属性に関するクイック リファレンスとして使用できます。 これらの要素は、FORM 要素コンテナー (作業項目の種類の定義の 3 番目にある最後の主要なセクション) で指定します。 1 つの作業項目フォーム内で、多くの要素が他の要素の内部に入れ子になって、グループ、セクション、またはタブを形成します。 これらの要素をグループ化する方法の詳細については、「作業項目フォームのデザイン」を参照してください。
このトピックの内容
FORM の例
FORM 要素の構文
FORM 要素によって指定される属性
スタンドアロン ラベル、ハイパーリンク、Web ページ、または HTML コンテンツを指定する要素
リンクの関係をフィルター処理および表示する要素
FORM の例
次の例は、FORM 要素の全体的な構造を示しています。 フォームのレイアウトは、Layout 要素を使用して指定します。 さまざまなクライアントを対象とする、異なるレイアウトを指定できます。 たとえば、Windows クライアントに 1 つのレイアウトを指定し、Team Web Access に他のレイアウトを指定できます。 通常レイアウトは、フォームの上部とタブのグループで構成されます。 レイアウトで要素が定義されている順序によって、フォーム上の要素の順序が決まります。
列内に表示される要素をグループ化するには、Group 要素と Column 要素を使用します。 フォーム上に表示するそれぞれのフィールドを定義するには、Control 要素を使用します。 フィールド グループのさまざまな機能領域をサポートするには、Tab 要素を使用します。
<FORM>
<Layout>
<Group>
<Column PercentWidth="70">
<Group>
<Column PercentWidth="100">
<Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />
<Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />
<Control FieldName="System.IterationPath" Type="WorkItemClassificationControl" Label="&Iteration Path:" LabelPosition="Left" />
<Group>
<Column PercentWidth="50">
<Control FieldName="Microsoft.VSTS.Common.ProductUnit" Type="FieldControl" Label="PU (Use Area Path)" LabelPosition="Left" />
</Column>
<Column PercentWidth="50">
<Control FieldName="Microsoft.VSTS.Common.Priority" Type="FieldControl" Label="Priority" LabelPosition="Left" />
</Column>
</Group>
</Column>
</Group>
</Column>
<Column PercentWidth="30">
<Group Label="Status">
<Column PercentWidth="100">
<Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />
<Control FieldName="System.State" Type="FieldControl" Label="State" LabelPosition="Left" />
<Control FieldName="System.AssignedTo" Type="FieldControl" Label="Assigned To" LabelPosition="Left" />
</Column>
</Group>
</Column>
</Group>
. . .
</Layout>
</FORM>
Form 要素
次の表に示す要素を使用して、情報と作業項目のフィールドをグループ化し、作業項目フォームに表示する方法を指定できます。
注意
最適な結果を得るには、Control 要素を Group にネストし、次に Group 要素を Column にネストする必要があります。このとき、列がフォームの幅全体に広がることがあります。また、すべての Column セクションを 1 つの Group にネストする必要があります。その場合、そのグループに表示されるラベルまたは境界がないこともあります。
要素 |
説明 |
必須? |
|
|---|---|---|---|
Column |
フォームの領域を列に分割します。 |
推奨 |
|
Control |
作業項目フォームに表示するフィールド、テキスト、ハイパーリンク、その他のコントロール要素を定義します。 詳細については、Control XML 要素のリファレンスを参照してください。 |
必要 |
|
FORM |
最上位のフォーム要素を定義します。 |
必要 |
|
Group |
要素を視覚的にグループ化します。Windows のグループ ボックスに似ています。 |
推奨 |
|
Layout |
作業項目フォームのレイアウトを定義します。 |
必要 |
|
Splitter |
1 つのフォームを 2 つの領域に分割して、2 つの兄弟フォーム要素のレイアウトをサポートします。 |
省略可能 |
|
Tab |
単一のタブのレイアウトを 1 つのタブ グループに定義します。 |
省略可能 |
|
TabGroup |
フォーム用に 1 つ以上のタブを定義します。 |
Optional |
FORM 要素の書式設定に使用する属性
次の表に示す属性を指定すると、作業項目フォームの多くの要素のスペーシングとサイズを制御できます。 詳細については、「作業項目フォームのデザイン」を参照してください。
属性 |
説明 |
適用可能な要素 |
|---|---|---|
ControlSpacing |
省略可能です。 コントロールの垂直オフセットを指定します。 Integer。 |
Layout |
FixedWidth |
省略可能です。 列の幅 (ピクセル単位) です。 PercentWidth と FixedWidth は同時に指定できません。 |
Column |
Label |
省略可能です。 コントロールまたはグループ用に表示されるテキスト。 ラベルを指定した場合、コントロールのメタデータでフィールドに関連付けられたラベルは無視されます。 Tab 要素では必須。 タブ用に表示されるテキスト。 LabelText は 1 ～ 80 文字で構成されたテキスト文字列です。 |
Control Group Tab |
LabelPosition |
省略可能です。 フィールドのデータに対するラベルの位置を指定します。 使用可能な値は、Top、Bottom、Left、および Right です。 |
Control |
LabelSpacing |
省略可能です。 コントロールのラベルと編集領域との間隔 (ピクセル数) を指定します。 |
Layout |
Margin |
省略可能です。 コントロールの周囲および隣接するコントロールとの間に設定する空白の大きさをピクセル単位で指定する (left、top、right、bottom) 形式の文字列です。 方向ごとに違う大きさを指定できます。 パターン値: ^\(\d+\,\d+\,\d+\,\d+\)$ パターン値の例 : (2,0,2,0) |
Control Group Layout Tab TabGroup |
MinimumSize |
省略可能です。 (width, height) 形式の文字列。 この値は、フォーム本体の最小サイズです。 コンテナー コントロールがこのサイズより小さい場合は、垂直および水平のスクロールバーが表示されます。 |
Control Layout |
Name |
省略可能です。 コントロールの名前です。 省略すると、FieldName と同じ名前になります。 |
Control |
Padding |
省略可能です。 コントロールの境界線の外側および内側に設定する空白の大きさをピクセル単位で指定する (top, bottom, left, right) 形式の文字列です。 方向ごとに違う大きさを指定できます。 |
Control Group Layout Tab TabGroup |
PercentWidth |
省略可能です。 コンテナー要素の幅のパーセントとして表される列の幅。 PercentWidth と FixedWidth は同時に指定できません。 |
Column |
ReadOnly |
省略可能です。 読み取り専用フィールドをコントロールで表示できます。 この属性がコントロールに与える効果は、コントロールの種類によって若干異なります。 |
Control |
Target |
省略可能です。 このレイアウトの適用対象となるクライアントを指定する文字列です。 Visual Studio では、Target 属性が省略されるか Windows フォームに設定された場合に、このレイアウトを使ってこの作業項目の種類が表示されます。 外部クライアントでは、Target で無視されるカスタムの Visual Studio 属性を使ってレイアウトを追加で指定できます。 有効な値は、次のとおりです。
|
Layout |
Type |
必須。 コントロールの型。 詳細については、Control XML 要素のリファレンスを参照してください。 |
Control |
スタンドアロン ラベル、ハイパーリンク、Web ページ、または HTML コンテンツを指定する要素
WebpageControlOptions 要素およびその子要素は、次の構文構造を持っています。
<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
<Link UrlRoot="UrlRoot" UrlPath ="UrlPathWithParameters">
<Param index="IndexValue" value="ParamValue" type ="Original | Current"/>
</Link>
<Content>
<![CDATA[Contents of HTML]]>
</Content>
</WebpageControlOptions>
次の表に示す要素を使用して、プレーンテキストやハイパーリンクのラベルの定義、フィールドへのハイパーリンクの追加、または作業項目フォームへの Web ページ コンテンツの表示を行います。 詳細については、「作業項目フォームでのヘルプ テキスト、ハイパーリンク、または Web コンテンツの提供」を参照してください。
要素 |
必須? |
説明 |
|
|---|---|---|---|
Content |
省略可能な WebpageControlOptions 要素。 |
CDATA HTML ベースのコンテンツを指定して作業項目フォームに表示します。 詳細については、「WebpageControlOptions XML 要素のリファレンス」を参照してください。 |
|
LabelText |
Control の場合、type="LabelControl" 要素は省略可能です。 |
プレーンまたはハイパーリンクのラベルを定義します。 詳細については、「LabelText および Text XML 要素のリファレンス」を参照してください。 |
|
Link |
Control の場合、type="FieldControl" 要素は省略可能です。 省略可能な Text 要素。 省略可能な WebpageControl 要素。 省略可能な WebpageControlOptions 要素。 |
フィールド、ラベル、または Web ブラウザーのコンテンツに対してハイパーリンクを定義して、作業項目フォームに表示します。 詳細については、「Link および Param XML 要素のリファレンス」を参照してください。 |
|
Param |
省略可能な Link 要素。 |
URLPath が Link 要素に指定されている場合にハイパーリンクの URL を確認するための値を指定します。 詳細については、「Link および Param XML 要素のリファレンス」を参照してください。 |
|
Text |
省略可能な LabelText 要素。 |
作業項目フォームに情報またはラベルを表示するためのコンテナー要素。 詳細については、「LabelText および Text XML 要素のリファレンス」を参照してください。 |
|
WebpageControlOptions |
Control の場合、type="WebpageControl" 要素は省略可能です。 |
Web ページ コントロールのオプションを指定するコンテナー要素。 詳細については、「WebpageControlOptions XML 要素のリファレンス」を参照してください。 |
リンクの関係をフィルター処理および表示する要素
LinksControlOptions 要素を使用して、作業項目に追加できるリンクを制御するオプションと、作業項目にリンクの一覧として表示する既定の列を制御するオプションを定義します。 作業項目フォームにリンク コントロールを追加する場合、ユーザーが作成できるリンクの種類を制限するフィルターと、ユーザーがリンクを作成できる作業項目の種類を制限するフィルターを指定できます。 LinksControlOptions 要素およびその子要素は、次の構造を持っています。
<LinksControlOptions>
<WorkItemLinkFilters FilterType="include | exclude | includeAll | excludeAll">
<Filter LinkType="linkTypeRefName" FilterOn="reverseName | forwardName" />
</WorkItemLinkFilters>
<ExternalLinkFilters FilterType ="include | exclude | includeAll | excludeAll">
<Filter LinkType="externalLinkName"/>
</ExternalLinkFilters>
<WorkItemTypeFilters Scope=" project | all" FilterType=" include | exclude | includeAll" />
<Filter WorkItemType="workItemTypeReferenceName"/>
</WorkItemTypeFilters>
<LinkColumns>
<LinkColumn RefName="referenceName" | LinkAttribute="linkAttributeName"/>
</LinkColumns>
</LinksControlOptions>
具体的には、次の表に示した要素を使用します。 これらの要素を使用する方法の詳細については、「リンク コントロールの定義とリンク関係の制限」および「LinksControlOptions 要素」を参照してください。
要素 |
必須? |
説明 |
|---|---|---|
LinksControlOptions |
Control の場合、type="LinksControl" 要素は省略可能です。 |
作業項目に追加できるリンクを制御するオプションと、作業項目にリンクの一覧として表示する既定の列を制御するオプションを定義する要素のコンテナーを提供します。 |
WorkItemLinkFilters |
省略可能な LinksControlOptions 要素。 |
チーム プロジェクト コレクションに定義されるリンクの種類に使用されるリンクのフィルター条件を指定する 1 つ以上の Filter 要素用のコンテナーを提供します。 |
ExternalLinkFilters |
省略可能な LinksControlOptions 要素。 |
他のチーム プロジェクトに定義されるリンクの種類に使用されるリンクのフィルター条件を指定する 1 つ以上の Filter 要素用のコンテナーを提供します。 |
WorkItemTypeFilters |
省略可能な LinksControlOptions 要素。 |
作業項目の種類に適用されるフィルター条件を指定する 1 つ以上の Filter 要素用のコンテナーを提供します。 |
Filter (リンクの種類) |
WorkItemLinkFilters 属性が FilterType または exclude の場合には、include 要素は必須です。 ExternalLinkFilters 属性が FilterType または exclude の場合には、include 要素は必須です。 |
作業項目用に作成できるリンクのセットに含めるリンクの種類またはリンクのセットから除外するリンクの種類を指定します。 |
Filter (作業項目の種類) |
WorkItemTypeFilters 属性が FilterType または exclude の場合には、include 要素は省略可能です。 |
ユーザーがリンクできる作業項目の種類のセットに含める作業項目の種類または作業項目の種類のセットから除外する作業項目の種類を指定します。 |
LinkColumns |
省略可能な LinksControlOptions 要素。 |
1 つ以上の LinkColumn タグ用のコンテナーを提供します。 |
LinkColumn |
必須の LinkColumns 要素 |
リンクの一覧として作業項目フォームに表示する作業項目のフィールドとリンクの種類の属性を指定します。 |