LinksControlOptions 元素

项目
04/10/2013

使用 LinksControlOptions 元素可定义一些选项，用于控制可向工作项添加的链接以及要为工作项中的链接列表显示的默认列。在向工作项窗体添加链接控件时，可以指定筛选器，以限制用户可查看和创建的链接类型以及用户可为其创建链接的工作项类型。特别地，按照指示使用以下元素：

WorkItemLinkFilters：用来限制当前团队项目中的工作项之间的链接类型。
ExternalLinkFilters：用于限制可以在工作项和其他对象（如变更集、超链接或版本控制文件）之间创建的链接类型。
WorkItemTypeFilters：用来限制用户可以根据工作项类型以及是否在当前团队项目中定义工作项创建的链接关系。

每个这些元素中，可以通过指定 Filter 元素来指定要包含或排除的链接类型或工作项类型。有关如何使用这些元素的更多信息，请参见定义链接控件以限制链接关系。

LinksControlOptions 元素是 CONTROL 元素的子元素。

架构层次结构

<xs:element name="LinksControlOptions" type="LinksControlOptionsType" minOccurs="0"/>
<xs:element name="WorkItemLinkFilters" type="WorkItemLinkFiltersType" minOccurs="0" maxOccurs="1"/>
<xs:element name="Filter" type="WorkItemLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="ExternalLinkFilters" type="ExternalLinkFiltersType" minOccurs="0" maxOccurs="1" />
<xs:element name="Filter" type="ExternalLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="WorkItemTypeFilters"   type="LinksControlWorkItemTypeFiltersElementType" minOccurs="0" maxOccurs="1" />
<xs:element name="Filter" type="LinksControlWorkItemTypeFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="LinkColumns" type="LinkColumnsType" minOccurs="0" maxOccurs="1" />
<xs:element name="LinkColumn" type="LinkColumnType" minOccurs="1" maxOccurs="unbounded"/>

<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="reference name" | LinkAttribute="link attribute name"/>
   </LinkColumns>
</LinksControlOptions>

特性和元素

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

子元素和特性

元素	特性	描述
LinksControlOptions		type="LinksControl" 时可选的 Control 元素。为一些元素提供容器，这些元素定义可向工作项添加的链接以及要为工作项中的链接关系列表显示的默认列。元素类型是复杂类型：LinksControlOptionsType。
WorkItemLinkFilters		可选的 LinksControlOptions 元素。为一个或多个 Filter 元素提供容器，这些元素指定的链接筛选条件用于为团队项目集合定义且在工作项之间创建关系的链接类型。元素类型是复杂类型：WorkItemLinkFiltersType。
	FilterType	必选的 WorkItemLinkFilters 特性。定义用于筛选 Filter 元素集中提供的链接类型集的方法。元素类型是简单类型：LinksControlFilterKind。您可以使用的有效值包括： exclude：用于禁止 Filter 元素中列出的那些链接类型创建的链接。 excludeAll：用于禁止所有链接类型。 include：用于允许只有在 Filter 元素中列出的这些链接类型。 includeAll：用于允许从所有链接类型创建的链接。
Filter		FilterType 为 exclude 或 include 时必需的 WorkItemLinkFilters 元素。如果 FilterType 为 excludeAll 或 includeAll，则不应指定任何 Filter 元素。对于可为工作项创建的链接集，指定要在其中包含或排除的链接类型。元素类型是简单类型：WorkItemLinkFilterElementType。
	LinkType	必选的 Filter 特性。指定链接类型的引用名称。有效的类型包括以下系统定义的链接类型： Storyboard System.LinkTypes.Dependency System.LinkTypes.Hierarchy System.LinkTypes.Related 此外，还可以为团队项目集合定义的自定义链接类型指定引用名称。有关更多信息，请参见链接类型元素参考。
	FilterOn	可选的 Filter 特性。指定要应用于链接类型的筛选器类型。元素类型是简单类型：LinksControlFilterOnKind。有效值为： forwardname：用于在为某类链接定义的正向名称上筛选。 reversename：用于在为某类链接定义的反向名称上筛选。如果未指定，则使用前向名称和反向名称筛选链接类型。说明如果链接类型拓扑为网络，则正向名称和反向名称相同。有关更多信息，请参见链接类型元素参考。
ExternalLinkFilters		可选的 LinksControlOptions 元素。为一个或多个 Filter 元素提供容器，用于指定链接类型以便用户创建与非工作项的对象（如变更集、超链接，和版本控制下的文件）的关系。元素类型是复杂类型：ExternalLinkFiltersType。
	FilterType	可选的 ExternalLinkFilters 特性。定义用于筛选 Filter 元素集中提供的链接类型列表的方法。元素类型是简单类型：LinksControlFilterKind。可以使用以下值： exclude：用于禁止 Filter 元素中出现的那些链接类型创建的链接。 excludeAll：用于禁止所有链接类型。 include：用于允许只有在 Filter 元素中列出的这些链接类型。 includeAll：用于允许从所有链接类型创建的链接。如果未指定，则将排除所有外部工作项的链接。
Filter		FilterType 为 exclude 或 include 时必需的 ExternalLinkFilters 元素。如果 FilterType 为 excludeAll 或 includeAll，则不应指定任何 Filter 元素。元素类型是复杂类型：ExternalLinkFilterElementType。对于用户可为工作项创建的链接集，指定要在其中包含或排除的链接类型的名称。
	LinkType	必选的 Filter 特性。指定要排除或包含的链接类型的引用名称。特性类型为简单类型：ExternalLinkTypeName。可以指定以下链接类型：在变更集中修复结果附件源代码文件测试结果工作项超链接
WorkItemTypeFilters		可选的 LinksControlOptions 元素。为一个或多个 Filter 元素提供容器，这些元素指定的筛选条件应用于工作项类型。元素类型是复杂类型：LinksControlWorkItemTypeFiltersElementType。
	Scope	可选的 WorkItemTypeFilters 特性。定义应用于 Filter 元素集中提供的工作项类型集的筛选范围。元素类型是简单类型：LinksControlWorkItemTypeFilterScopeKind。您可以使用的有效值包括： all：用于允许链接创建到 Filter 标记中指定的所有工作项类型。 project：用于允许仅对为当前项目定义的这些工作项类型创建链接。如果未指定，则允许所有类型工作项的链接。
	FilterType	必选的 WorkItemTypeFilters 特性。定义用于筛选 Filter 元素集中提供的工作项类型集的方法。元素类型是简单类型：LinksControlWorkItemTypeFilterKind。可以使用以下值： exclude：用于禁止 Filter 元素中的工作项类型。 excludeAll：用于禁止所有工作项类型。 include：用于允许 Filter 元素中的工作项类型。 includeAll：用于允许所有工作项类型。如果不指定任何这些值，则允许指向所有工作项类型的链接。
Filter		FilterType 为 exclude 或 include 时可选的 WorkItemTypeFilters 元素。如果 FilterType 为 excludeAll 或 includeAll，则不应指定任何 Filter 元素。指定要从可链接的工作项目组包含或排除的工作项的类型。元素类型是复杂类型：LinksControlWorkItemTypeFilterElementType。
	WorkItemType	必选的 Filter 特性。指定要过滤的工作项类型的引用名称。特性类型为 typelib:NonEmptyPlainConstant。最小长度：1；最大长度：255。模式值：^[^\\]*$ 模式值示例：Task
LinkColumns		可选的 LinksControlOptions 元素。为一个或多个 LinkColumn 元素提供容器。元素类型是复杂类型：LinkColumnsType。
LinkColumn		必需的 LinkColumns 元素。指定要为针对工作项定义的链接列表显示的工作项字段和链接类型特性。元素类型是复杂类型：LinkColumnType。默认显示此列列表。用户可从链接列表添加和删除列。列出 LinkColumn 元素的顺序定义工作项表单中显示列字段的顺序。
	RefName	可选的 LinkColumn 特性。指定 RefName 或 LinkAttribute，但非同时指定二者。指定对应于团队项目集合的有效的工作项字段的引用名称。特性类型为 typelib:ReferenceFieldName。
	LinkAttribute	可选的 LinkColumn 特性。指定 RefName 或 LinkAttribute，但非同时指定二者。指定对应于团队项目集合的有效链接类型的任何特性的引用名称。特性类型为 typelib:ReferenceFieldName。

父元素

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

备注

LinksControlOptions 元素是 Control 元素（其中 ControlType="LinksControl"）的可选子元素。还可以使用 LinksControlOptions 元素来支持以下操作：

指定所需的限制，用于根据链接类型来控制创建与其他工作项的关系，并可选地控制链接类型的转发和反转名称。
指定所需的限制，用于根据外部链接类型来控制创建与非工作项（如变更集、超链接等）的对象之间的关系。
指定所需的限制，用于根据工作项类型来控制创建与其他工作项的关系，并可选地控制在其中定义这些工作项的团队项目。
指定要显示链接列表中的信息的默认列字段。

示例

下面的示例指定如何启用链接的创建，其类型是 Microsoft.VSTS.Common.TestedBy 并为该链接类型显示 Forward Name。筛选器选项不允许创建所有外部链接类型的链接。此外，列出的链接显示的默认列字段对应以下友名称：ID、工作项类型、标题、指派给、状态和链接注释字段：有关更多示例，请参见定义链接控件以限制链接关系。

<Control Type="LinksControl" Name="TestedBy" Label="&amp;Work items testing this bug:" LabelPosition="Top">
   <LinksControlOptions>
      <WorkItemLinkFilters FilterType="include">
         <Filter LinkType="Microsoft.VSTS.Common.TestedBy" FilterOn="forwardname" />
      </WorkItemLinkFilters>
      <WorkItemTypeFilters FilterType="include">
          <Filter WorkItemType="Test Case" />
      </WorkItemTypeFilters>
          <ExternalLinkFilters FilterType="excludeAll"/>
      <LinkColumns>
          <LinkColumn RefName="System.ID" />
          <LinkColumn RefName="System.WorkItemType" />
          <LinkColumn RefName="System.Title" />
          <LinkColumn RefName="System.AssignedTo" />
          <LinkColumn RefName="System.State" />
          <LinkColumn LinkAttribute="System.Links.Comment" />
      </LinkColumns>
   </LinksControlOptions>
</Control>

LinksControl 工具栏按钮

Type=”LinksControl” 的每个 Control 元素提供一个工具栏，其中包含在下一个插图显示的按钮：

工作项窗体链接工具栏控件

在执行特定操作后，这些按钮变为可用：

只有在保存打开的工作项之后，用于创建与打开工作项链接的工作项的按钮 () 才可用。
只有在链接控件选项卡中至少列出一个工作项时，用于打开查询中工作项列表的按钮 () 或用于在 Microsoft Office 客户端中打开工作项列表的按钮 () 才可用。
只有在单击链接控件选项卡中列出的一个或多个工作项之后，用于打开工作项的按钮 ()、编辑链接的按钮 () 和删除链接的按钮 () 才可用。

显示的链接控件对于这两 Team Web Access 和团队资源管理器的，但，配置它仅仅呈现 Storyboard 链接时。在这种情况下，工具栏只包含某些控件添加新链接，打开该链接的项目以及删除该链接。此外，Team Web Access 版本显示在控件中菜单中的 启动情节提要 链接。

Team Web Access 中的情节提要链接控件

架构定义

LinksControlOptionsType
WorkItemLinkFiltersType
WorkItemLinkFilterElementType
ExternalLinkFiltersType
ExternalLinkFilterElementType
LinksControlFilterKind
LinksControlFilterOnKind
ExternalLinkTypeName
LinksControlWorkItemTypeFilterElementType
LinksControlWorkItemTypeFilterElementType
LinksControlWorkItemTypeFilterScopeKind
LinksControlWorkItemTypeFilterKind
LinkColumnsType
LinkColumnType

LinksControlOptionsType

<xs:complexType name="LinksControlOptionsType">
   <xs:all>
      <xs:element name="LinkColumns" type="LinkColumnsType" minOccurs="0" maxOccurs="1" />
      <xs:element name="WorkItemLinkFilters" type="WorkItemLinkFiltersType" minOccurs="0" maxOccurs="1"/>
      <xs:element name="ExternalLinkFilters" type="ExternalLinkFiltersType" minOccurs="0" maxOccurs="1" />
      <xs:element name="WorkItemTypeFilters" type="LinksControlWorkItemTypeFiltersElementType" minOccurs="0" maxOccurs="1" />
   </xs:all>
</xs:complexType>

WorkItemLinkFiltersType

<xs:complexType name="WorkItemLinkFiltersType" >
   <xs:sequence>
      <xs:element name="Filter" type="WorkItemLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
      <xs:attribute name="FilterType" type="LinksControlFilterKind" use="required" />
</xs:complexType>

WorkItemLinkFilterElementType

<xs:complexType name="WorkItemLinkFilterElementType" >
   <xs:attribute name="LinkType" type="typelib:ReferenceFieldName" use="required" />
   <xs:attribute name="FilterOn" type="LinksControlFilterOnKind" use="optional" />
</xs:complexType>

ExternalLinkFiltersType

<xs:complexType name="ExternalLinkFiltersType" >
   <xs:sequence>
      <xs:element name="Filter" type="ExternalLinkFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
      <xs:attribute name="FilterType" type="LinksControlFilterKind" use="required" />
</xs:complexType>

ExternalLinkFilterElementType

<xs:complexType name="ExternalLinkFilterElementType" >
   <xs:attribute name="LinkType" type="ExternalLinkTypeName" use="required" />
</xs:complexType>

LinksControlFilterKind

<xs:simpleType name="LinksControlFilterKind">
   <xs:restriction base="xs:string">
      <xs:enumeration value="include" />
      <xs:enumeration value="exclude" />
      <xs:enumeration value="includeAll" />
      <xs:enumeration value="excludeAll" />
   </xs:restriction>
</xs:simpleType>

LinksControlFilterOnKind

<xs:simpleType name="LinksControlFilterOnKind">
   <xs:restriction base="xs:string">
      <xs:enumeration value="forwardname" />
      <xs:enumeration value="reversename" />
   </xs:restriction>
</xs:simpleType>

ExternalLinkTypeName

<xs:simpleType name="ExternalLinkTypeName">
   <xs:restriction base="xs:string">
      <xs:minLength value="1"/>
      <xs:maxLength value="128"/>
   </xs:restriction>
</xs:simpleType>

LinksControlWorkItemTypeFilterElementType

<xs:complexType name="LinksControlWorkItemTypeFiltersElementType" >
   <xs:sequence>
      <xs:element name="Filter" type="LinksControlWorkItemTypeFilterElementType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
      <xs:attribute name="Scope" type="LinksControlWorkItemTypeFilterScopeKind" use="optional" />
      <xs:attribute name="FilterType" type="LinksControlWorkItemTypeFilterKind" use="required" />
</xs:complexType>

LinksControlWorkItemTypeFilterElementType

<xs:complexType name="LinksControlWorkItemTypeFilterElementType" >
   <xs:attribute name="WorkItemType" type="typelib:NonEmptyPlainConstant" use="required" />
</xs:complexType>

LinksControlWorkItemTypeFilterScopeKind

<xs:simpleType name="LinksControlWorkItemTypeFilterScopeKind">
   <xs:restriction base="xs:string">
   <xs:enumeration value="project" />
   <xs:enumeration value="all" />
</xs:restriction>
</xs:simpleType>

LinksControlWorkItemTypeFilterKind

<xs:simpleType name="LinksControlWorkItemTypeFilterKind">
   <xs:restriction base="xs:string">
      <xs:enumeration value="include" />
      <xs:enumeration value="exclude" />
      <xs:enumeration value="includeAll" />
   </xs:restriction>
</xs:simpleType>

LinkColumnsType

<xs:complexType name="LinkColumnsType" >
   <xs:sequence>
      <xs:element name="LinkColumn" type="LinkColumnType" minOccurs="1" maxOccurs="unbounded"/>
   </xs:sequence>
</xs:complexType>

LinkColumnType

<xs:complexType name="LinkColumnType" >
   <!-- Must be one or the other, but not both -->
      <xs:attribute name="LinkAttribute" type="typelib:ReferenceFieldName" use="optional" />
      <xs:attribute name="RefName" type="typelib:ReferenceFieldName" use="optional" />
</xs:complexType>

元素信息

命名空间	https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef
架构名称	工作项类型定义
验证文件	WorkItemTypeDefinition.xsd
元素类型	LinksControlOptionsType
是否可以为空	不适用

请参见

概念

链接类型元素参考

指定工作项窗体控件

定义链接控件以限制链接关系

其他资源

定义自定义链接类型

修订记录

日期	修订记录	原因
2012 年九月	更正了语法大小写结构。所有枚举值区分大小写。	内容 Bug 修复。

2012 年九月

更正了语法大小写结构。所有枚举值区分大小写。

内容 Bug 修复。