通过

所有 FORM XML 元素引用

  • 项目

本主题中提供的信息可用作有关控制工作项类型窗体的所有元素和主要特性的快速参考。 在 FORM 元素容器以及工作项类型定义的第三个和最后一个主要部分中指定这些元素。 许多元素嵌套在其他元素中，从而构成了工作项窗体中的不同组、部分或选项卡。 有关如何将这些元素进行分组的详细信息，请参阅设计工作项窗体。

主题内容

  • FORM 示例

  • FORM 元素的语法

  • FORM 元素指定的特性

  • 指定独立标签、超链接、网页或 HTML 内容的元素

  • 筛选和显示链接关系的元素

FORM 示例

下面的示例演示 FORM 元素的整体结构。 使用 Layout 元素来指定窗体的布局。 可以为不同的客户端指定不同的布局。 例如，可以为 Windows 客户端指定一种布局，并为 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>

窗体元素

使用下表中描述的元素可以指定信息和工作项字段在工作项窗体中进行分组和显示的方式。

备注

为获得最佳效果，应将 Control 元素嵌套在 Group 中，并应将 Group 元素嵌套在 Column 中，即使该列跨越整个窗体宽度也应如此。此外，还应将每个 Column 部分嵌套在一个 Group 中，即使该组没有可见标签或边界也应如此。

元素

描述

是否必需？

Column

将窗体区域划分为列。

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

推荐

Control

定义要在工作项窗体上显示的字段、文本、超链接或其他控件元素。

<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" />

有关详细信息，请参阅控件 XML 元素引用。

必需

FORM

定义顶级窗体元素。

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

必需

Group

提供元素的直观分组，与 Windows GroupBox 相似。

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

推荐

Layout

定义工作项窗体的布局。

<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

将窗体划分为两个区域，以支持两个同级窗体元素的布局。

Splitter />

可选

Tab

定义选项卡组中单个选项卡的布局。

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

可选

TabGroup

为窗体定义一个或多个选项卡。

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

可选

用于为 FORM 元素设置格式的特性

通过指定下表中描述的特性，可以控制许多工作项窗体元素的间距和大小。 有关详细信息，请参阅设计工作项窗体。

特性

描述

适用的元素

ControlSpacing

可选。 指定控件的垂直偏移量。 Integer。

Layout

FixedWidth

可选。 列宽，以像素为单位。 PercentWidth 和 FixedWidth 是互斥的。

Column

Label

可选。 要为控件或组显示的文本。 如果指定了标签，则该标签会重写与控件元数据中的字段关联的任何标签。

对于 Tab 元素是必需的。 要为选项卡显示的文本。

LabelText 是包含 1 到 80 个字符的文本字符串。

Control

Group

Tab

LabelPosition

可选。 相对于字段数据的标签位置。 可能的值为：上、下、左和右。

Control

LabelSpacing

可选。 指定标签与控件的编辑区域之间的像素数量。

Layout

Margin

可选。 （左、上、右、下）格式的字符串，以像素为单位指定控件周围以及控件与其相邻元素之间的空间量。 可以为每个边指定不同的空间量。

模式值：^\(\d+\,\d+\,\d+\,\d+\)$

模式值示例：(2,0,2,0)

Control

Group

Layout

Tab

TabGroup

MinimumSize

可选。 窗体的字符串（宽度，高度）。 此值指定窗体自身的最小尺寸。 如果容器控件的大小小于此大小，将显示水平滚动条和垂直滚动条。

Control

Layout

Name

可选。 控件的名称。 如果未指定，则名称与 FieldName 相同。

Control

Padding

可选。 （上、下、左、右）格式的字符串，以像素为单位指定在控件外边框和内边框周围的空间量。 可以为每个边指定不同的空间量。

Control

Group

Layout

Tab

TabGroup

PercentWidth

可选。 列宽，以包含元素的宽度的百分比表示。 PercentWidth 和 FixedWidth 是互斥的。

Column

ReadOnly

可选。 可以在控件中显示只读字段。 不同的控件响应此特性的方式稍有不同。

Control

Target

可选。 指定向哪个客户端应用此布局的字符串。 如果省略 Visual Studio 特性或将其设置为“Windows 窗体”，则 Target 使用此布局来显示此工作项类型。 外部客户端可以使用 Target 忽略的自定义 Visual Studio 特性来指定其他布局。

以下为有效值：

  • WinForms：将窗体应用于团队资源管理器和 Team Explorer Everywhere。

  • Web：将窗体应用于 Team Web Access。

Layout

Type

必需。 控件的类型。 有关详细信息，请参阅控件 XML 元素引用。

Control

指定独立标签、超链接、网页或 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 内容。

元素

是否必需？

说明

Content

可选的 WebpageControlOptions 元素。

指定要在工作项窗体中显示的基于 CDATA HTML 的内容。

<Content>
   <![CDATA[Contents of HTML]]>
</Content>

有关详细信息，请参阅 WebpageControlOptions XML 元素引用。

LabelText

Control 时可选的 type="LabelControl" 元素。

定义纯文本或超链接标签。

有关详细信息，请参阅 LabelText 和 Text XML 元素引用。

Link

Control 时可选的 type="FieldControl" 元素。

可选的 Text 元素。

可选的 WebpageControl 元素。

可选的 WebpageControlOptions 元素。

为要在工作项窗体中显示的字段、标签或 Web 浏览器内容定义超链接。

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

有关详细信息，请参阅 Link 和 Param XML 元素引用。

Param

可选的 Link 元素。

在为 URLPath 元素指定 Link 时，指定用于确定超链接 URL 的值。

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

有关详细信息，请参阅 Link 和 Param XML 元素引用。

Text

可选的 LabelText 元素。

要在工作项窗体上显示的信息或标签的容器元素。

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

有关详细信息，请参阅 LabelText 和 Text XML 元素引用。

WebpageControlOptions

Control 时可选的 type="WebpageControl" 元素

为网页控件指定选项的容器元素。

有关详细信息，请参阅 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 元素

为一个或多个 Filter 元素提供容器，这些元素指定的链接筛选条件用于为团队项目集合定义的链接类型。

ExternalLinkFilters

可选的 LinksControlOptions 元素

为一个或多个 Filter 元素提供容器，这些元素指定的筛选条件用于在其他团队项目中定义的链接类型。

WorkItemTypeFilters

可选的 LinksControlOptions 元素

为一个或多个 Filter 元素提供容器，这些元素指定的筛选条件应用于工作项类型。

Filter（链接类型）

WorkItemLinkFilters 特性为 FilterType 或 exclude 时必需的 include 元素。

ExternalLinkFilters 特性为 FilterType 或 exclude 时必需的 include 元素。

对于可为工作项创建的链接集，指定要在其中包含或排除的链接类型。

Filter（工作项类型）

WorkItemTypeFilters 特性为 FilterType 或 exclude 时可选的 include 元素。

对于用户可链接的工作项类型集，指定其中要包含或排除的工作项类型。

LinkColumns

可选的 LinksControlOptions 元素

为一个或多个 LinkColumn 标记提供容器。

LinkColumn

必需的 LinkColumns 元素

指定要在工作项窗体上为链接列表显示的工作项字段和链接类型特性。

请参见

概念

设计工作项窗体

其他资源

工作项跟踪：XML 元素定义的索引