通过

LinksControlOptions 元素

  • 项目

更新：2011 年 5 月

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

  • WorkItemLinkFilters：用来限制当前团队项目中的工作项之间的链接类型。

  • ExternalLinkFilters：用于限制可以在工作项和其他对象（如变更集、超链接或版本控制文件）之间创建的链接类型。

  • WorkItemTypeFilters：用来限制用户可以根据工作项类型以及是否在当前团队项目中定义工作项创建的链接关系。

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

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

架构层次结构

WITD

   WORKITEMTYPE

       FORM

           布局

               组

               列

               Tab

                     控件

<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 特性。

指定链接类型的引用名称。 特性类型为 typelib:ReferenceFieldName。 有关更多信息，请参见使用链接类型。

 

FilterOn

可选的 Filter 特性。

指定要应用于链接类型的筛选器类型。 元素类型是简单类型：LinksControlFilterOnKind。

有效值为：

  • forwardName：用于在为某类链接定义的正向名称上筛选。

  • revserseName：用于在为某类链接定义的反向名称上筛选。

如果未指定，则使用前向名称和反向名称筛选链接类型。

注意注意
如果链接类型拓扑为网络，则正向名称和反向名称相同。有关更多信息，请参见使用链接类型。

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>

架构定义

  • 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

是否可以为空

不适用

请参见

概念

使用链接类型

指定工作项窗体控件

其他资源

自定义如何通过链接类型关联工作项

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

修订记录

Date

修订记录

原因

2011 年 5 月

更正了多个 XML 元素的大小写。 工作项跟踪架构定义以 Camel 大小写格式定义 FORM 元素的所有子元素，并以全大写格式定义所有其他元素。

内容 Bug 修复

2011 年 1 月

替换到已删除的主题的链接。

信息补充。

2010 年 7 月

添加了可以和 ExternalLinkFilters 元素一起使用的引用名称的完整列表。

内容 Bug 修复

2010 年 6 月

修订了ExternalLinkFilters 和 WorkItemTypeFilters 元素的说明。

内容 Bug 修复