在工作项窗体上提供帮助文本、超链接或 Web 内容

项目
06/09/2015

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

使用本主题中介绍的窗体控件可以在窗体中添加用于各个字段的工具提示文本、独立文本、网页超链接或是嵌入 HTML 内容或 Web 内容。

通过修改工作项类型的定义来修改工作项窗体。您可以使用 witadmin 命令行工具，请参阅导入、导出和管理工作项类型 [witadmin] 或过程编辑器。

过程编辑器是 Visual Studio 的一个增强工具外接程序，可下载和安装。 “工具”菜单下的过程编辑器提供一个图形用户界面，可自定义 Team Foundation Server 中用于跟踪工作项的对象。可以使用此工具导入和导出工作项类型并修改其定义。有关详细信息，请参见 Microsoft 网站上的以下页面：Team Foundation Server 增强工具。

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

可以采用两种方式之一提供帮助文本。第一种方法是，将 HELPTEXT 元素作为子元素添加到类型定义的 FIELD 部分的 FIELDS 元素中。使用 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 2012 客户端，文本标记显示为超链接（在其中通过 Link 标记定义 URL）。

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

下面的示例说明如何将超链接添加到字段标签的一部分。在此示例中，URL 通过基于特定工作项而分配给 Param 元素的值来确定。

<Control Type="FieldControl" FieldName="System.IterationPath">
   <LabelText LabelPosition="Left">
      <Text>
         <Link UrlRoot="@ProcessGuidance" UrlPath="{0}.html">
            <Param Index="0" vValue"System.WorkItemType"/>         </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://" UrlPath="myserver.com:8080/tfs/myproject/{0}/_workItems#_a=edit&id=">      <Param Index="0" Value="System.State" Type ="Original"/>
   </Link>
</Control>

显示 Web 内容

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

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

下面的示例演示如何通过使用 WebpageControlOptions 和 Link 元素提供指向页面的 URL，来嵌入来自网页的内容。

<Tab Label="Web">
   <Group>
      <Column PercentWidth="100">
         <Control Type="WebpageControl" Name="WssPortalPage" Label="WssPortalPage" LabelPosition="Top" >
            < WebpageControlOptions AllowScript="true">
               <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>

请参见

概念

设计工作项窗体

自定义工作跟踪对象以支持团队的进程