在工作项窗体上提供帮助文本、过程指导、Web 内容和网页链接

项目
08/12/2011

更新：2011 年 5 月

自定义工作项窗体时，可能要提供有助于您的团队在窗体中定义字段的信息或指向这样的内容的链接。如果您在窗体中嵌入了该信息或让该信息能轻松获得，则团队成员将能更好地跟踪有用的数据。

通过使用本主题中描述的窗体控件，可以为各个字段添加工具提示文本、独立文本或指向网页的超链接，也可以在窗体中嵌入 HTML 内容或 Web 内容。

主题内容

提供帮助文本或工具提示文本
添加独立的文本和超链接字段标签
显示 Web 内容
嵌入过程指南

提供帮助文本或工具提示文本

可通过以下两种方法之一来提供帮助文本。第一种方法是，将 HELPTEXT 元素作为子元素添加到类型定义的 FIELDS 部分的 FIELD 元素中。通过使用 HELPTEXT，可以为字段创建工具提示。使用这种方法时，字符数将限定为 255 个。

<FIELD name="Sub-Title" refname="ACME.ACE.ImpactStatement" type="HTML" >
<HELPTEXT>Provide information about the impact to the ACE organization. </HELPTEXT>
</FIELD>

第二种方法是，使用 LabelText 和 Text 子元素指定独立文本。使用此方法时，您可以根据需要添加任意多的信息，并且文本总是在窗体上显示。无需任何用户操作。还可以使用 Link 元素添加指向更多信息的可选链接，如下面的示例所示。

<Control FieldName=" ACME.ACE.ImpactStatement" Type="HTMLControl" Label="Impact" LabelPosition="Left"> 
   <LabelText>
      <Text> Provide information about the impact to the ACE organization. Specifically address the following: customer segment, target strategic opportunity, resources required, and time dependencies. For more detailed information, see the Impact Statement specification at:
         <Link OpenInNewWindow="true" UrlRoot=http://ACE.ImpactStatement.aspx />
      </Text>
   </LabelText>
</Control>

添加独立的文本和超链接字段标签

通过使用 Control 元素的 Type 特性 LabelControl 选项，可向不与任何工作项字段相关联的工作项窗体中添加文本。文本可为纯文本或可提供超链接。此外，使用 FieldControl 选项还可将超链接附加到已添加的字段标签上。

示例：纯文本标签

下面的示例将纯文本“Fill in the details of the bug here。 Fields that are not required are recommended to be filled in.”添加到工作项字段。

<Control Type="LabelControl" Label="Fill in the details of the bug here. Fields that are not required are recommended to be filled in." />

示例：超链接字段标签

下面的示例演示如何向字段标签添加超链接。

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="Title 1"
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
            Title 2
      </Text>
   </LabelText>
</Control>

提示

对于尚未升级到最新版本的 Team Foundation 客户，会显示 Label 特性文本。对于 Visual Studio 2010 客户端，文本标记将显示为带有由 Link 标记定义的 URL 的超链接。

示例：部分文本带有超链接的字段标签

下面的示例演示如何向字段标签的部分内容添加超链接。在此示例中，URL 将由分配给基于特定工作项的 Param 元素的值确定。

<Control Type="FieldControl" FieldName="System.IterationPath">
   <LabelText LabelPosition="Left">
      <Text>
         <Link UrlPath="http://{0}/sites/{1}/render.aspx?wit=bug&amp;topic=Iteration">
            <Param value="@Server"/>
            <Param value="System.Project"/>
         </Link>
            Iteration Path
      </Text>
      <Text> (must be 3 levels deep)</Text>
   </LabelText>
</Control>

示例：超链接文本标签

超链接文本标签

应用到独立标签的超链接的示例

下面的示例演示如何向工作项窗体中显示的文本添加超链接。

<Group>
   <Column PercentWidth="100">
      <!-- Standalone label control 2 -->
      <Control Type="LabelControl" Label="How do I use this work item?">
         <Link UrlRoot="http://www.live.com"></Link>
      </Control>
   </Column>
</Group>

示例：在单个标签中组合文本和超链接

在单个标签中组合文本和超链接

应用到文本的两个超链接的示例

下面的示例演示如何在工作项窗体上向标签的部分内容添加两个超链接。

<Group>
   <Column PercentWidth="100">
   <!-- Standalone label control 3 -->
      <Control Type="LabelControl" Name="Microsoft.VSTS.Common.GuidanceLabel3">
         <LabelText>
            <Text>Click here for </Text>
            <Text>
               <Link UrlRoot="https://www.msn.com"></Link>
               work item guidance</Text>
            <Text> or here for </Text>
            <Text>
               <Link UrlRoot="http://www.msdn.com"></Link>
               process guidance
            </Text>
         </LabelText>
      </Control>
   </Column>
</Group>

示例：参数生成的超链接字段标签

下面的示例演示如何向字段标签添加超链接，该字段标签从为打开工作项计算的参数值生成。

<Control Type="FieldControl" FieldName="System.State" Label="&amp;State:" LabelPosition="Left">
   <Link OpenInNewWindow="true" URLRoot="http://{0}/sites/{1}/render.aspx?wit=bug&amp;state={2}">
      <Param value="@Server"/>
      <Param value="System.Project"/>
      <Param value="System.State" type ="original"/>
   </Link>
</Control>

显示 Web 内容

可使用 Type 特性 WebpageControl 选项将 Web 内容在工作项窗体中作为控件进行显示，而不是作为指向单独网页的链接进行显示。此显示可用于提供指标，团队成员通过这些指标可以查看报表、面板或其他基于 HTML 的内容。您可提供指向内容的链接，或在 CDATA 标记中嵌入原始 HTML 内容。

示例：显示由 URI 提供的内容

下面的示例演示如何使用 WebpageControlOptions 和 LINK 元素提供指向某网页的 URL，从而嵌入该页面中的内容。

<Tab Label="Web">
   <Group>
      <Column PercentWidth="100">
         <Control Type="WebpageControl" Name="WssPortalPage" Label="WssPortalPage" LabelPosition="Top" Dock="Fill">
            < WebpageControlOptions AllowScript="false">
               <Link UrlRoot="http://www.msdn.com" />
            </WebpageControlOptions >
         </Control>
      </Column>
   </Group>
</Tab>

示例：显示在 CDATA 标记中提供的内容

下面的示例演示如何向 CDATA 标记中包含的工作项窗体添加 HTML 内容。

<Control Type="WebpageControl">
   <WebpageControlOptions>
      <Content>
      <![CDATA[Place HTML Formatted Content Here ]]
   </Content>
   </WebpageControlOptions >
</CONTROL>

嵌入过程指南

若要让过程指南在工作项窗体上可用，则可能要添加包含有关工作项类型的工作流和使用情况的信息的选项卡。可以使用 Type 特性 WebpageControl 选项完成此操作。此选项支持使用 WebpageControlOptions 和 Content 子元素将丰富格式的文本和图像嵌入到窗体中。

<FORM>
. . .
<TabGroup>
. . . 
   <Tab Label="Process Guidance">
      <Group>
         <Column PercentWidth="100">
            <Control Type="WebpageControl">
            <WebpageControlOptions >
            <Content>
               <![CDATA[Place HTML Formatted Process Guidance Content Here ]]>
            </Content>
            </WebpageControlOptions>
            </Control>
         </Column>
      </Group>
   </Tab>
. . .
</TabGroup>
. . .
</FORM>

请参见

修订记录

日期	修订记录	原因
2011 年 5 月	更正了某些元素的大小写和 XML 语法的特性。用于跟踪工作项的架构定义以 Camel 大小写格式定义 FORM 元素的所有子元素，并将所有其他元素的名称中的所有字母设置为大写。	内容 Bug 修复

2011 年 5 月

更正了某些元素的大小写和 XML 语法的特性。用于跟踪工作项的架构定义以 Camel 大小写格式定义 FORM 元素的所有子元素，并将所有其他元素的名称中的所有字母设置为大写。

内容 Bug 修复