Link 和 Param XML 元素引用
使用 Link 元素,可将超链接添加到工作项窗体的字段或独立标签上。 在以下实例中使用 Link 元素可:
向字段标签添加超链接
向独立标签或部分信息性文本添加超链接
指定要在工作项窗体中显示的内容的 URL
若要将元素添加到窗体,可修改工作项类型的定义。 请参阅修改或添加自定义工作项类型 (WIT)。
Link 元素是 Control 元素的子元素,或是 WebpageControlTarget 或 WebpageControlOptions 元素的子元素。 有关这些元素的详细信息,请参阅Control XML 元素引用和WebpageControlOptions XML 元素引用。
架构层次结构
<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters"> <Param Index="IndexValue " Value="ParamValue " Type ="Original | Current"/> </Link>
特性和元素
下列各节描述了特性、子元素和父元素。
子元素和特性
元素 |
特性 |
描述 |
---|---|---|
Link |
|
Control 时可选的 type="FieldControl" 元素。 可选的 LabelText 元素。 可选的 Text 元素。 可选的 WebpageControlOptions 元素。 用于定义超链接或 URL 的容器元素。 元素类型是复杂类型:HyperLinkType。 |
|
UrlRoot |
必选的 Link 特性。 指定标签链接到的 URL 的协议和服务器名。 支持的协议有 HTTP、HTTPS 和 MAILTO。 可以对指定服务器名进行硬编码,也可以使用以下宏之一并且(可选)将其他地址信息附加到宏: 备注 每个宏都链接到为定义了 Link 元素的工作项窗体的团队项目定义并启用的 URL。如果没有为团队项目设置或启用任何资源,则会出现“找不到页面”错误。
若要确定前两个宏的硬编码值,可以打开团队项目的项目门户设置。 有关详细信息,请参阅配置或重定向过程指南。 特性类型为简单类型:NonBlankString。 |
|
UrlPath |
可选的 Link 特性。 指定超链接的 URL 路径。 使用此特性可指定在运行时确定的变量参数。 特性类型为简单类型:NonBlankString。 |
Param |
|
可选的 Link 元素。 指定了 UrlPath 时是必需的。 指定在指定了 UrlPath 时要用于确定超链接 URL 的值。 元素类型是复杂类型:HyperLinkParamType。 |
|
Index |
必选的 Param 特性。 指定其中的值必须为格式化为 URL 字符串的参数的索引。 不需要按顺序对索引值进行排序;但是,它们必须与 URLPath 字符串中的索引号匹配。 特性类型为 PositiveInteger。 第一个索引号应是 0。 |
|
Value |
必选的 Param 特性。 指定与超链接 URL 路径的值关联的数字。 指定必须格式化为 URLPath 字符串的值。 值必须是工作项类型定义中使用的字段的有效引用名称。 支持 @Me 变量。 它会替换为查看工作项窗体的当前团队成员的名称。 值项不区分大小写 特性类型为 xs:string。 |
|
Type |
可选的 Param 特性。 指定必须用于参数的字段的原始值。 特性类型为简单类型:HyperLinkParamValueKind。 有效值如下:
如果未指定此特性,则字段的当前值用作参数 |
父元素
元素 |
描述 |
---|---|
必需。 定义要在工作项窗体上显示的字段、文本、超链接或其他控件元素。 |
|
可选的 Control 元素。 要在工作项窗体上显示的标签的容器元素。 |
|
可选的 LabelText 元素。 要在工作项窗体上显示的信息或标签的容器元素。 |
|
可选的 Control 元素。 为网页控件指定选项的容器元素。 |
备注
Link 元素的默认行为是在工作项窗体或网页中打开超链接。 如果超链接编写为在新窗口中打开 (target="_blank"),则会打开外部浏览器。
可以通过在 LabelText 元素中添加多个 Text 元素来组合纯文本和超链接文本。
LabelText 元素仅由运行最新版本的 团队资源管理器 的客户端识别。 因此,指定子 Link 元素时,必须在 Control 元素中指定Label 特性。 对于运行最新版本的 团队资源管理器 的客户端,LabelText 元素提供的文本会显示在工作项窗体中。 对于运行以前版本的 团队资源管理器 的客户端,Control 元素 Label 特性指定的文本将显示在工作项窗体中。
示例:指定带参数的超链接
描述
下面的示例演示如何定义链接到迭代主题的过程指南的超链接:
https://serverName/sites/collectionName/projectName/render.aspx?wit=bug&topic=Iteration
项目的名称派生自分配给 System.Project 字段的值。
代码
<Link UrlRoot="https://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&topic=Iteration">
<Param Index="0" Value="System.Project" />
</Link>
示例:向独立标签添加超链接
描述
下面的示例演示如何向工作项窗体上的文本“work item guidance”分配超链接。
代码
<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 |
可为空 |
不适用 |