LinksControlOptions 元素

项目
11/18/2015

使用 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		Control 时可选的 type="LinksControl" 元素。为一些元素提供容器，这些元素定义可向工作项添加的链接以及要为工作项中的链接列表显示的默认列。元素类型是复杂类型：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。模式值：^[^\\]*$ 模式值示例：任务
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 客户端 () 中的工作项列表的按钮才可用。
仅当单击链接控件选项卡中列出的一个或多个工作项后，用于打开工作项 ()、编辑链接 () 和删除链接 () 的按钮才可用。

除非链接控件配置为仅呈现 Storyboard 链接，否则对于 Team Web Access 和团队资源管理器显示的链接控件是相同的。在这种情况下，工具栏仅包含用于添加新链接、打开链接的项和删除链接的控件。同样，Team Web Access 版本在控制菜单内显示**“启动情节提要”**链接。

情节提要链接控件

架构定义

LinksControlOptionsType
WorkItemLinkFiltersType
WorkItemLinkFilterElementType
ExternalLinkFiltersType
ExternalLinkFilterElementType
LinksControlFilterKind
LinksControlFilterOnKind
ExternalLinkTypeName
LinksControlWorkItemTypeFiltersElementType
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>

LinksControlWorkItemTypeFiltersElementType

<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
可为空	不适用

请参见

概念

链接类型元素引用

指定工作项窗体控件

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

其他资源

定义自定义链接类型

通过

LinksControlOptions 元素

特性和元素

子元素和特性

父元素

备注

示例

LinksControl 工具栏按钮

架构定义

LinksControlOptionsType

WorkItemLinkFiltersType

WorkItemLinkFilterElementType

ExternalLinkFiltersType

ExternalLinkFilterElementType

LinksControlFilterKind

LinksControlFilterOnKind

ExternalLinkTypeName

LinksControlWorkItemTypeFiltersElementType

LinksControlWorkItemTypeFilterElementType

LinksControlWorkItemTypeFilterScopeKind

LinksControlWorkItemTypeFilterKind

LinkColumnsType

LinkColumnType

元素信息

请参见

概念

其他资源

其他资源