通过

所有 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>

窗体组件

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

备注

为了获得最佳结果，您应嵌套在 Group的 Control 元素，因此，您应嵌套在 Column的 Group 元素，因此，即使该列跨越整个窗体。此外，还应嵌套在 Group的每个 Column 部分，因此，即使该组没有可见的标签或边界也应如此。

元素

说明

必需?

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" 
Dock="Fill | Top | Bottom | Left | Right" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" ReadOnly="True | False" MinimumSize="(Width,Height)" 
Name="InstanceName" />

有关更多信息，请参见 Control XML 元素引用。

要求

FORM

定义顶级窗体元素。

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

要求

Group

提供元素的直观分组，与 windows GroupBox。

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

建议

Layout

定义工作项窗体的布局。

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

要求

Splitter

将窗体分为两个区域支持两个同级窗体布局。

Splitter Dock="Left" />

选项

Tab

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

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

选项

TabGroup

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

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

选项

返回页首

用于为 FORM 元素的特性

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

特性

说明

适用的元素

ControlSpacing

选项。 指定控件的垂直偏移量。 整数。

Layout

Dock

选项。 拉伸以填充容器的其余部分的字段控件或拆分器。 有效的字段停靠值为: 加载，顶部，底部，左侧， 和 权限。

  • Fill:对齐字段，使它填满容器。

  • Top:对齐字段与容器的顶部。

  • Bottom:对齐字段与容器底部。

  • Left:对齐字段或拆分器与容器的左侧。 此值是 SPLITTER 元素的唯一支持的方向。

  • Right:对齐字段或拆分器与容器的右侧。

Control

Splitter

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

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

下面的值有效:

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

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

Layout

Type

必需。 控件的类型。 有关更多信息，请参见 Control 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 元素。

定义字段、标签或浏览器目录的超链接在工作项窗体中显示

<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 元素定义的索引