Share via

Link 和 Param XML 元素引用

  • 项目

更新：2011 年 5 月

使用 Link 元素，可将超链接添加到工作项窗体的字段或独立标签上。 在以下实例中使用 Link 元素以进行以下操作：

  • 向字段标签添加超链接

  • 向独立标签或信息文本部分添加超链接

  • 指定要在工作项表单显示的内容的 URL

Link 元素是 Control 元素的子元素，或者是 WebpageControlTarget 或 WebpageControlOptions 元素的子元素。 有关这些元素的更多信息，请参见 Control XML 元素引用和 WebpageControlOptions XML 元素引用。

架构层次结构

WITD

   WORKITEMTYPE

       FORM

           布局

               组

               列

               Tab

                     控件

<xs:element name="Link" type="HyperLinkType" minOccurs="0" maxOccurs="1" />
<xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>

<LINK URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param index="IndexValue " value="ParamValue " type ="Original | Current"/>
</LINK>

特性和元素

以下几节描述了属性、子元素和父元素。

子元素和特性

元素

特性

说明

Link

 

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

可选的 LabelText 元素。

可选的 Text 元素。

可选的 WebpageControlOptions 元素。

用于定义超链接或 URL 的容器元素。 元素类型是复杂类型：HyperLinkType。

 

UrlRoot

必选的 Link 特性。

指定协议和标签链接的 URL 的服务器名称。 受支持的协议是 HTTP、HTTPS 和 MAILTO。

可以将指定的服务器名称硬编码，或者可以使用下列宏之一并可以选择向宏追加其他的地址信息。

注意注意
针对已定义 Link 元素的工作项窗体的团队项目定义和启用的 URL 的每个宏链接。如果尚未对团队项目提供或启用任意资源，则将出现“未找到页”错误。

  • @PortalPage：当前团队项目的 SharePoint 站点的 URL（例如，https://serverName/sites/collectionName/TeamProjectName）。

  • @ProcessGuidanceUrl：团队项目过程指南的 SharePoint 站点的 URL。

  • @ReportManagerUrl：承载当前团队项目报表管理器的服务器的 URL。 这为报告提供了到文件夹视图的链接（例如 https://serverName/Reports/Pages/Folder.aspx?ItemPath=/collectionName/teamProjectName）。

  • @ReportServiceSiteUrl：承载当前团队项目的SQL Server Reporting Services 的服务器加上该团队项目的基路径的 URL（例如，https://serverName/Reports/Pages/reportservice.asmx?ItemPath=/collectionName/teamProjectName）。

若要为前两个宏确定硬编码的值，您可以为团队项目打开项目门户网站设置。 有关更多信息，请参见 访问团队项目门户网站和过程指南。

特性类型为简单类型：NonBlankString。

 

UrlPath

可选的 Link 特性。

指定超链接的 URL 路径。 使用特性以指定在运行时确定的变量参数。 特性类型为简单类型：NonBlankString。

Param

 

可选的 Link 元素。 当指定了 UrlPath 时，是必需的。

在指定 UrlPath 时，指定要用于确定超链接 URL 的值。

元素类型是复杂类型：HyperLinkParamType。

 

index

必选的 Param 特性。

指定参数的索引，其中值必须格式化为 URL 字符串。 并不要求按顺序排序索引值，但必须匹配 URLPath 字符串中的索引数。

特性类型为 PositiveInteger。 第一个索引号应为 1。

 

value

必选的 Param 特性。

指定与超链接的 URL 路径的值相关联的数字。

指定必须格式化到 URLPath 字符串中的值。 值必须是有效的字段引用名称，其在工作项类型定义中使用。

支持 @Me 变量。 替换为正在查看工作项窗体的当前团队成员的姓名。 值项不区分大小写

特性类型为 xs:string。

 

type

可选的 Param 特性。

指定字段的原始值必须能用于该参数。 特性类型为简单类型：HyperLinkParamValueKind。

有效值如下：

  • Original：专用于使用原始参数值来确定 URL 路径。

  • Current：专用于使用当前参数值来确定 URL 路径。

如果未指定此特性，则该字段的当前值用作参数

父元素

元素

说明

控件

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

LabelText

可选的 Control 元素。

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

Text

可选的 LabelText 元素。

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

WebpageControlOptions

可选的 Control 元素。

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

有关更多信息，请参见 Displaying Web Content within a Work Item Form: WebpageControlOptions Elements。

备注

LINK 元素的默认行为是在工作项表单或网页中打开超链接。 如果超链接经授权在新窗口中打开 (target="_blank")，则会打开外部浏览器。

可以通过在 LABELTEXT 元素中添加多个 TEXT 元素来组合普通文本和超链接文本。

LABELTEXT 元素仅由正在运行最新版本的 团队资源管理器 客户端识别。 因此必须在 CONTROL 元素中指定 Label 特性，前提是在您指定子 LINK 元素时。 对于运行 团队资源管理器 最新版本的客户端，LABELTEXT 元素提供的文本会在工作项窗体中显示。 对于运行 团队资源管理器 以前版本的客户端，CONTROL 元素 Label 特性指定的文本会在工作项窗体中显示。

示例：指定带参数的超链接

说明

下面的示例演示如何定义超链接，其链接到迭代主题中的过程指南：

http://服务器名称/sites/集合名称/项目名称/render.aspx?wit=bug&amp;topic=Iteration

项目的名称来自 System.Project 字段的赋值。

代码

<Link UrlRoot="https://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&amp;topic=Iteration">
   <Param index="1 " value="System.Project"/>
</Link>

示例：将超链接添加到独立标签

说明

下面的示例示出如何为工作项表单上的文本“工作项指南”指定超链接。

代码

<Control type="LabelControl">
   <LabelText> 
      <Text>
         <Link UrlRoot="https://www.msn.com" />
      work item guidance
      </Text>
   </LabelText> 
</Control>

示例：将超链接添加到字段

说明

下面的示例示出如何为工作项表单上的字段添加超链接。

代码

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="This text comes from the Label attribute:">
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
         This text comes from the inner Label Text
      </Text>
   </LabelText>
</Control>

架构定义

  • HyperLinkType

  • NonBlankString

  • HyperLinkParamType

  • HyperLinkParamValueKind

复杂类型：HyperLinkType。

<xs:complexType name="HyperLinkType" >
   <xs:sequence>
      <xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
   <xs:attribute name="UrlRoot"  type="NonBlankString" use="required" />
   <xs:attribute name="UrlPath"  type="NonBlankString" use="optional" />
</xs:complexType>

HyperLinkParamType

<xs:complexType name="HyperLinkParamType" >
   <xs:attribute name="Index"     type="PositiveInteger" use="required" />
   <xs:attribute name="Value"     type="xs:string" use="required" />
   <xs:attribute name="Type" type="HyperLinkParamValueKind" use="optional" />
</xs:complexType>

NonBlankString

<xs:simpleType name="NonBlankString">
   <xs:restriction  base="xs:string">
   <xs:pattern value=".*\S+.*"/>
   </xs:restriction>
</xs:simpleType>

HyperLinkParamValueKind

<xs:simpleType name="HyperLinkParamValueKind">
   <xs:restriction base="xs:string">
   <xs:enumeration value="Original"/>
   <xs:enumeration value="Current"/>
   </xs:restriction>
</xs:simpleType>

元素信息

命名空间

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

架构名称

工作项类型定义

验证文件

WorkItemTypeDefinition.xsd

元素类型

HyperLinkType, HyperLinkParamType

是否可以为空

不适用

请参见

概念

指定工作项窗体控件

设计和自定义工作项窗体

其他资源

Elements (Work Item Type Definition Schema)

修订记录

Date

修订记录

原因

2011 年 5 月

更正了 XML 语法的多个元素和特性的大小写。 跟踪工作项的架构定义将 FORM 元素的全部子元素定义为 Camel 大小写格式版本，并以全大写格式定义所有其他元素。

内容 Bug 修复

2011 年 1 月

移除了指向已移除主题的链接。

信息补充。