LinksControlOptions 要素

  • [アーティクル]

更新 : 2011 年 5 月

LinksControlOptions 要素を使用して、作業項目に追加できるリンクを制御するオプションと、作業項目にリンクの一覧として表示する既定の列を制御するオプションを定義します。 作業項目フォームにリンク コントロールを追加する場合、ユーザーが表示および作成できるリンクの種類を制限するフィルターと、ユーザーがリンクを作成できる作業項目の種類を制限するフィルターを指定できます。 具体的には、以下の要素を指示に従って使用します。

  • WorkItemLinkFilters: 現在のチーム プロジェクトの作業項目間のリンクの種類を制限します。

  • ExternalLinkFilters: 作業項目や、変更セット、ハイパーリンク、バージョン管理ファイルなどのその他のオブジェクト間で作成できるリンクの種類を制限します。

  • WorkItemTypeFilters: ユーザーが作業項目の種類に基づいて作成できるリンクの関係と、その作業項目が現在のチーム プロジェクトで定義されるかどうかを制限します。

これらの各要素で、Filter 要素を指定して、含めるまたは除外するリンクの種類または作業項目の種類を指定できます。 これらの要素の使用方法の詳細については、「リンク コントロールの定義とリンク関係の制限」を参照してください。

LinksControlOptions 要素は、CONTROL 要素の子要素です。

スキーマの階層

WITD

   WORKITEMTYPE

       FORM

           Layout

               Group

               Column

               Tab

                     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 要素。

チーム プロジェクト コレクションに定義されるリンクの種類に使用されるリンクのフィルター条件を指定し、作業項目間の関係を作成する 1 つ以上の 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 要素。

変更セット、ハイパーリンク、バージョン管理下のファイルなど、作業項目でないオブジェクトとの関係を作成するためにユーザーが指定できるリンクの種類を指定する 1 つ以上の 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 要素。

作業項目の種類に適用されるフィルター条件を指定する 1 つ以上の 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 要素。

1 つ以上の LinkColumn 要素用のコンテナーを提供します。 要素型は、LinkColumnsType 複合型です。

LinkColumn

 

必須の LinkColumns 要素です。

作業項目に対して定義されているリンクの一覧に表示する作業項目のフィールドとリンクの種類の属性を指定します。 要素型は、LinkColumnType 複合型です。

この列の一覧は、既定の表示です。 ユーザーは、この一覧に対して列を追加または削除できます。

LinkColumn 要素が表示される順序は、作業項目フォームで列フィールドが表示される順序を定義します。

 

RefName

省略可能な LinkColumn 属性です。 RefName または LinkAttribute の一方だけを指定します。

チーム プロジェクト コレクションの有効な作業項目の種類に対応する参照名を指定します。 属性型は typelib:ReferenceFieldName です。

 

LinkAttribute

省略可能な LinkColumn 属性です。 RefName または LinkAttribute の一方だけを指定します。

チーム プロジェクト コレクションの有効なリンクの種類の属性に対応する参照名を指定します。 属性型は typelib:ReferenceFieldName です。

親要素

要素

説明

Control

必須。 作業項目フォームに表示するフィールド、テキスト、ハイパーリンク、その他のコントロール要素を定義します。

解説

LinksControlOptions は、ControlType="LinksControl" の場合、Control 要素の省略可能な子要素です。 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

  • 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 形式で、その他すべての要素がすべて大文字で定義されます。

コンテンツ バグ修正

2011 年 1 月

削除されたトピックへのリンクを置換。

情報の拡充

2010 年 7 月

ExternalLinkFilters 要素で使用できる参照名の一覧を追加。

コンテンツ バグ修正

2010 年 6 月

ExternalLinkFilters および WorkItemTypeFilters 要素についての説明を変更。

コンテンツ バグ修正