LinksControlOptions 項目

發行項
08/12/2011

更新：2011 年 5 月

您可以使用 LinksControlOptions 項目來定義選項，以控制可加入至工作項目的連結，以及您要針對工作項目中的連結清單顯示的預設資料行。當您將連結控制項加入至工作項目表單時，您可以指定篩選條件，以限制使用者可檢查和建立的連結類型，並限制使用者可建立哪些工作項目類型的連結。尤其您可以依指示使用下列項目：

WorkItemLinkFilters：用於目前 Team 專案中以限制工作項目之間的連結類型。
ExternalLinkFilters：用來限制可在工作項目與其他物件 (例如變更集、超連結或版本控制檔案) 之間建立的連結類型。
WorkItemTypeFilters：用來限制連結的關聯性，使用者可根據工作項目類型以及工作項目是否定義於目前 Team 專案中，來建立這些關聯性。

在其中每一個項目中，您可以指定 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 項目的容器，這些項目指定連結篩選準則，而這些準則要用於 Team 專案集合所定義的連結類型，並可建立工作項目之間的關聯性。項目型別是複雜型別：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。模式值：^[^\\]*$ 模式值範例：工作
LinkColumns		選擇性 LinksControlOptions 項目。提供一個或多個 LinkColumn 項目的容器。項目型別是複雜型別：LinkColumnsType。
LinkColumn		必要的 LinkColumns 項目。指定工作項目之定義連結清單所要顯示的工作項目欄位和連結類型屬性。/ 項目型別是複雜型別：LinkColumnType。此資料行清單是預設顯示。使用者可加入及移除連結清單中的資料行。 LinkColumn 項目列示的順序定義工作項目表單內顯示資料行欄位的順序。
	RefName	選擇性 LinkColumn 屬性。指定 RefName 或 LinkAttribute，但不可同時指定。指定對應於 Team 專案集合有效工作項目欄位的參考名稱。屬性型別為 typelib:ReferenceFieldName。
	LinkAttribute	選擇性 LinkColumn 屬性。指定 RefName 或 LinkAttribute，但不可同時指定。指定對應於 Team 專案集合有效連結類型之任何屬性的參考名稱。屬性型別為 typelib:ReferenceFieldName。

父項目

項目	描述
Control	必要項。定義要顯示在工作項目表單上的欄位、文字、超連結或其他控制項項目。

備註

LinksControlOptions 是 Control 項目 (其中 ControlType="LinksControl") 的選擇性子項目。您可以使用 LinksControlOptions 項目來支援下列動作：

指定一些限制，這些限制會根據連結類型 (或者，連結類型的正向名稱和反向名稱)，控制與其他工作項目之間關聯性的建立作業。
指定一些限制，這些限制會根據外部連結類型，控制與工作項目以外物件 (例如變更集、超連結等等) 之間關聯性的建立作業。
這些限制會根據連結類型 (或者，根據定義這些工作項目的 Team 專案)，控制與其他工作項目之間關聯性的建立作業。
指定您想要顯示連結清單資訊的預設資料行欄位。

範例

下列範例指定如何建立型別是 Microsoft.VSTS.Common.TestedBy 的連結，並且顯示這個連結型別的 Forward Name。 filter 選項不允許建立所有外部連結型別的連結。此外，所列連結的顯示預設資料行欄位對應下列易記的名稱：ID, Work Item Type, Title, Assigned To, State，以及連結的定義 Comment 欄位。如需更多範例，請參閱定義連結控制項以限制連結關聯性。

<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
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
可以是空白	不適用

請參閱

概念

使用連結類型

指定工作項目表單控制項

其他資源

透過連結類型自訂工作項目間的關聯性

定義連結控制項以限制連結關聯性

變更記錄

日期	記錄	原因
2011 年 5 月	已更正幾個 XML 項目的案例。工作項目追蹤結構描述類型定義用來將 FORM 項目的所有子項目定義為依照 Camel 命名法的大小寫慣例，而將其他所有項目定義為全部大寫。	內容 Bug 修正。
2011 年 1 月	已取代已移除之主題的連結。	資訊加強。
2010 年 7 月	已加入可以搭配 ExternalLinkFilters 項目使用的參考名稱完整清單。	內容 Bug 修正。
2010 年 6 月	已修訂 ExternalLinkFilters 和 WorkItemTypeFilters 項目的描述。	內容 Bug 修正。

2011 年 5 月

已更正幾個 XML 項目的案例。工作項目追蹤結構描述類型定義用來將 FORM 項目的所有子項目定義為依照 Camel 命名法的大小寫慣例，而將其他所有項目定義為全部大寫。

內容 Bug 修正。

2011 年 1 月

已取代已移除之主題的連結。

資訊加強。

2010 年 7 月

已加入可以搭配 ExternalLinkFilters 項目使用的參考名稱完整清單。

內容 Bug 修正。

2010 年 6 月

已修訂 ExternalLinkFilters 和 WorkItemTypeFilters 項目的描述。

內容 Bug 修正。

共用方式為

LinksControlOptions 項目

屬性和項目

子項目及屬性

父項目

備註

範例

結構描述定義

LinksControlOptionsType

WorkItemLinkFiltersType

WorkItemLinkFilterElementType

ExternalLinkFiltersType

ExternalLinkFilterElementType

LinksControlFilterKind

LinksControlFilterOnKind

ExternalLinkTypeName

LinksControlWorkItemTypeFiltersElementType

LinksControlWorkItemTypeFilterElementType

LinksControlWorkItemTypeFilterScopeKind

LinksControlWorkItemTypeFilterKind

LinkColumnsType

LinkColumnType

項目資訊

請參閱

概念

其他資源

變更記錄

其他資源