すべての 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="&amp;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 要素

次の表に示す要素を使用して、情報と作業項目のフィールドをグループ化し、作業項目フォームに表示する方法を指定できます。

<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Column >

<Control FieldName="FieldName" Type="AttachmentsControl | DateTimeControl | FieldControl | 
HtmlFieldControl | LabelControl | LinksControl | WebpageControl | WorkItemClassificationControl | 
WorkItemLogControl" Label="LabelText" LabelPosition="Top | Bottom | Left | Right" 
Padding="(top, bottom, left, right)" 
Margin="( top, bottom, left, right)" ReadOnly="True | False" MinimumSize="(Width,Height)" 
Name="InstanceName" />

<FORM>
   <Layout> . . . </Layout>
</FORM>

<Group Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Column> . . . </Column>
</Group >

<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(top, bottom, left, right)" 
Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance">
   <Group> . . . </Group>
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Layout>

Splitter />

<Tab Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Tab>

<TabGroup Padding="( top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Tab> . . . </Tab>
</TabGroup>

FORM 要素の書式設定に使用する属性

次の表に示す属性を指定すると、作業項目フォームの多くの要素のスペーシングとサイズを制御できます。 詳細については、「作業項目フォームのデザイン」を参照してください。

スタンドアロン ラベル、ハイパーリンク、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>
   <![CDATA[Contents of HTML]]>
</Content>

<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param />
</Link>

<Param index="IndexValue " value="ParamValue " type ="Original | Current"/>

<Text>
   <Link >
      <Param />
   </Link>
   LabelText
</Text>

リンクの関係をフィルター処理および表示する要素

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 要素」を参照してください。

参照

概念

作業項目フォームのデザイン

その他の技術情報

作業項目の追跡: XML 要素定義に対するインデックス