Éléments LinksControlOptions

  • Article

Utilisez l'élément LinksControlOptions pour définir des options pour contrôler les liens pouvant être ajoutés à un élément de travail et les colonnes par défaut à afficher dans la liste de liens d'un élément de travail. Lorsque vous ajoutez un contrôle de lien à un formulaire d'élément de travail, vous pouvez spécifier des filtres qui restreignent les types de liens que les utilisateurs peuvent afficher et créer et les types d'éléments de travail entre lesquels les utilisateurs peuvent créer des liens. Plus particulièrement, vous utilisez les éléments suivants comme indiqué :

  • WorkItemLinkFilters : Utilisé pour restreindre les types des liens entre les éléments de travail dans le projet d'équipe en cours.

  • ExternalLinkFilters: Utilisé pour limiter les types de liens qui peuvent être créés entre les éléments de travail et d'autres objets, tels que les ensembles de modifications, les liens hypertextes ou les fichiers sous contrôle de version.

  • WorkItemTypeFilters : Utilisé pour restreindre relations de liens que les utilisateurs peuvent créer en fonction du type d'élément de travail et si l'élément de travail est définie dans le projet d'équipe en cours.

Dans chacun de ces éléments, vous pouvez indiquer des éléments Filter pour spécifier les types de lien ou types d'éléments de travail que vous souhaitez inclure ou exclure. Pour plus d'informations sur l'utilisation de ces éléments, consultez Définition des contrôles de liens pour restreindre les relations de liens.

L'élément LinksControlOptions est un élément enfant de l'élément CONTROL.

Hiérarchie de schéma

WITD

   WORKITEMTYPE

       FORM

           Disposition

               Groupe

               Colonne

               Onglet

                     Contrôle

<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>

Attributs et éléments

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.

Éléments enfants et attributs

Élément

Attribut

Description

LinksControlOptions

 

Élément Control facultatif lorsque type="LinksControl".

Fournit un conteneur pour les éléments qui définissent les liens pouvant être ajoutés à un élément de travail et les colonnes par défaut à afficher dans la liste des relations de liens d'un élément de travail.

L'élément est de type complexe : LinksControlOptionsType.

WorkItemLinkFilters

 

Élément LinksControlOptions facultatif.

Fournit un conteneur pour un ou plusieurs éléments Filter qui spécifient les critères de filtre de lien à utiliser pour les types de liens définis pour la collection de projets d'équipe et créent des relations entre des éléments de travail.

L'élément est de type complexe : WorkItemLinkFiltersType.

 

FilterType

Attribut WorkItemLinkFilters requis.

Définit la méthode utilisée pour filtrer le jeu de types de lien fourni dans le jeu d'éléments Filter. L'élément est de type simple : LinksControlFilterKind.

Les valeurs valides que vous pouvez utiliser sont :

  • exclude : Utilisé pour ne pas autoriser la création de liens à partir de ces types de liens répertoriés dans les éléments Filter.

  • excludeAll : à utiliser pour interdire tout type de lien.

  • include : Utilisé pour autoriser uniquement ces types de liens répertoriés dans les éléments Filter.

  • includeAll : Utilisé pour autoriser la création de liens à partir de n'importe quel type de lien.

Filter

 

Élément WorkItemLinkFilters obligatoire lorsque FilterType a la valeur exclude ou include.

Lorsque le FilterType est excludeAll ou includeAll, aucun élément Filter ne doit être spécifié.

Spécifie les types de liens à inclure ou exclure du jeu des liens qui peuvent être créés pour l'élément de travail. L'élément est de type simple : WorkItemLinkFilterElementType.

 

LinkType

Attribut Filter requis.

Spécifie le nom de référence d'un type de lien. Le type de l'attribut est typelib:ReferenceFieldName. Pour plus d'informations, consultez Utilisation des types de liens.

 

FilterOn

Attribut Filter facultatif.

Spécifie le type de filtre à appliquer au type de lien. L'élément est de type simple : LinksControlFilterOnKind.

Les valeurs valides sont :

  • forwardName : Utilisé pour filtrer sur le nom de transfert défini pour un type de lien.

  • revserseName : permet de filtrer sur le nom inverse défini pour un type de lien.

Si non spécifié, à la fois, les noms directs et inverses sont utilisés pour filtrer le type de lien.

RemarqueRemarque
Si la topologie de type de lien est Réseau, les noms direct et inverse sont les mêmes.Pour plus d'informations, consultez Utilisation des types de liens.

ExternalLinkFilters

 

Élément LinksControlOptions facultatif.

Fournit un conteneur pour un ou plusieurs éléments Filter qui spécifient les types de lien que les utilisateurs peuvent indiquer pour créer des relations aux objets qui ne sont pas des éléments de travail, tels que des ensembles de modifications, des liens hypertextes, et des fichiers sous le contrôle de version. Le type d'élément est complexe : ExternalLinkFiltersType.

 

FilterType

Attribut ExternalLinkFilters facultatif.

Définit la méthode utilisée pour filtrer la liste des types de liens fournie dans le jeu d'éléments Filter. Le type d'élément est simple : LinksControlFilterKind.

Vous pouvez adopter les valeurs suivantes :

  • exclude : Utilisé pour ne pas autoriser la création de liens à partir de ces types de liens qui apparaissent dans les éléments Filter.

  • excludeAll : à utiliser pour interdire tout type de lien.

  • include : Utilisé pour autoriser uniquement ces types de liens répertoriés dans les éléments Filter.

  • includeAll : Utilisé pour autoriser la création de liens à partir de n'importe quel type de lien.

Si aucune valeur n'est spécifiée, tous les liens vers des éléments de travail externes sont exclus.

Filter

 

Élément ExternalLinkFilters obligatoire lorsque FilterType a la valeur exclude ou include.

Lorsque le FilterType est excludeAll ou includeAll, aucun élément Filter ne doit être spécifié.

L'élément est de type complexe : WorkItemLinkFiltersType.

Spécifie le nom des types de liens à inclure dans l'ensemble de liens que les utilisateurs peuvent créer pour l'élément de travail ou à exclure de cet ensemble.

 

LinkType

Attribut Filter requis.

Spécifie le nom de référence d'un type de lien à exclure ou inclure. Le type d'attribut est simple : ExternalLinkTypeName. Vous pouvez spécifier les types de liens suivants :

  • Résolu dans l'ensemble de modifications

  • Pièce jointe de résultat

  • Fichier de code source

  • Résultat de test

  • Lien hypertexte vers un élément de travail

WorkItemTypeFilters

 

Élément LinksControlOptions facultatif.

Fournit un conteneur pour un ou plusieurs éléments Filter qui spécifient les critères de filtre à appliquer aux types d'éléments de travail.

Le type d'élément est complexe : LinksControlWorkItemTypeFiltersElementType.

 

Scope

Attribut WorkItemTypeFilters facultatif.

Définit la portée du filtre appliqué au jeu de types d'éléments de travail fourni dans le jeu d'éléments Filter. L'élément est de type simple : LinksControlWorkItemTypeFilterScopeKind.

Les valeurs valides que vous pouvez utiliser sont :

  • all : Utilisé pour autoriser la création de liens vers tous les types d'éléments de travail spécifiés dans les balises Filter.

  • project : permet de créer des liens uniquement vers les types d'éléments de travail définis pour le projet actuel.

Si rien n'est spécifié, les liens vers tous les types d'éléments de travail sont autorisés.

 

FilterType

Attribut WorkItemTypeFilters requis.

Définit la méthode utilisée pour filtrer le jeu de types d'éléments de travail fourni dans le jeu d'éléments Filter. Le type d'élément est simple : LinksControlWorkItemTypeFilterKind.

Vous pouvez adopter les valeurs suivantes :

  • exclude : Utilisé pour ne pas autoriser les types d'éléments de travail dans les éléments Filter.

  • excludeAll : à utiliser pour interdire tous les types d'éléments de travail.

  • include : Utilisé pour autoriser les types d'éléments de travail dans les éléments Filter.

  • includeAll : à utiliser pour autoriser tous les types d'éléments de travail.

Si vous ne spécifiez pas l'une de ces valeurs, vous autorisez les liens à tous les types d'éléments de travail.

Filter

 

Élément WorkItemTypeFilters facultatif lorsque l'attribut FilterType a la valeur exclude ou include.

Lorsque FilterType a la valeur excludeAll ou includeAll, vous ne devez pas spécifier d'éléments Filter.

Spécifie les types des éléments de travail à inclure dans l'ensemble de types d'éléments de travail vers lesquels un lien peut être établi ou à exclure de cet ensemble. L'élément est de type complexe : LinksControlWorkItemTypeFilterElementType.

 

WorkItemType

Attribut Filter requis.

Spécifie le nom de la référence d'un type d'élément de travail à filtrer. Le type de l'attribut est : typelib:NonEmptyPlainConstant.

Longueur minimale : 1 ; longueur maximale : 255.

Valeur de modèle : ^[^\\]*$

Exemple de valeur de modèle : Tâche

LinkColumns

 

Élément LinksControlOptions facultatif.

Fournit un conteneur pour un ou plusieurs éléments LinkColumn. L'élément est de type complexe : LinkColumnsType.

LinkColumn

 

Élément LinkColumns obligatoire.

Spécifie les champs d'élément de travail et les attributs de type de lien affichés pour la liste des liens définis pour un élément de travail. L'élément est de type complexe : LinkColumnType.

Cette liste de colonnes est l'affichage par défaut. L'utilisateur peut ajouter et supprimer des colonnes dans la liste de liens.

L'ordre dans lequel les éléments LinkColumn sont répertoriés définit l'ordre d'affichage des champs de colonne dans le formulaire d'élément de travail.

 

RefName

Attribut LinkColumn facultatif. Spécifiez RefName ou LinkAttribute, mais pas les deux.

Spécifie le nom de référence correspondant à un champ d'élément de travail valide pour la collection de projets d'équipe. Le type de l'attribut est typelib:ReferenceFieldName.

 

LinkAttribute

Attribut LinkColumn facultatif. Spécifiez RefName ou LinkAttribute, mais pas les deux.

Spécifie le nom de référence correspondant à tout attribut d'un type de lien valide pour la collection de projets d'équipe. Le type de l'attribut est typelib:ReferenceFieldName.

Éléments parents

Élément

Description

Contrôle

Obligatoire. Définit un élément de champ, de texte, de lien hypertexte ou d'autre contrôle à afficher sur le formulaire d'élément de travail.

Notes

LinksControlOptions est un élément enfant facultatif de l'élément Control où ControlType="LinksControl". Vous pouvez utiliser l'élément LinksControlOptions pour prendre en charge les actions suivantes :

  • Spécifiez les restrictions qui gèrent la création des relations à d'autres éléments de travail selon le type de lien et, éventuellement, les noms directs et inverses des types de lien.

  • Spécifiez les restrictions qui gèrent la création des relations aux objets autres que des éléments de travail, tels que l'ensemble de modifications, le lien hypertexte, etc., en fonction des types de lien externe.

  • Spécifiez les restrictions qui gèrent la création des relations à d'autres éléments de travail selon le type d'élément de travail et, éventuellement, le projet d'équipe dans lequel ces éléments de travail sont définis.

  • Spécifiez les champs de colonne par défaut dont vous souhaitez afficher les informations pour la liste de liens.

Exemple

L'exemple suivant spécifie comment permettre la création de liens dont le type est Microsoft.VSTS.Common.TestedBy et afficher le nom direct (Forward Name) pour ce type de lien. Les options de filtre interdisent la création de liens vers tous les types de liens externes. De plus, les champs de colonne par défaut affichés pour les liens répertoriés correspondent aux noms conviviaux suivants: ID, Type d'élément de travail, Titre, Assigné À, État, et le champ Commentaire défini pour le lien. Pour plus d'exemples, consultez Définition des contrôles de liens pour restreindre les relations de liens.

<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>

Définitions de schéma

  • 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>

Informations sur les éléments

Espace de noms

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

Nom du schéma

Définition du type d'élément de travail

Fichier de validation

WorkItemTypeDefinition.xsd

Type d'élément

LinksControlOptionsType

Peut être vide

Non applicable

Voir aussi

Concepts

Utilisation des types de liens

Spécification des contrôles de formulaire d'élément de travail

Autres ressources

Personnalisation des relations entre éléments de travail au moyen des types de liens

Définition des contrôles de liens pour restreindre les relations de liens

Historique des modifications

Date

Historique

Motif

Mai 2011

A corrigé le cas de plusieurs éléments XML. La définition de schéma pour le suivi des éléments de travail définit tous les éléments enfants de l'élément FORM en casse mixte et tous les autres éléments en majuscules.

Résolution des bogues de contenu.

Janvier 2011

Liens remplacés vers les rubriques qui ont été supprimées.

Améliorations apportées aux informations.

Juillet 2010

Ajout d'une liste complète de noms de référence que vous pouvez utiliser avec l'élément ExternalLinkFilters.

Résolution des bogues de contenu.

Juin 2010

Révision des descriptions des éléments ExternalLinkFilters et WorkItemTypeFilters.

Résolution des bogues de contenu.