Partager via


Éléments LinksControlOptions

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. Quand vous ajoutez le 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 vers lesquels les utilisateurs peuvent créer des liens. Plus précisément, vous utilisez les éléments suivants comme indiqué :

  • WorkItemLinkFilters : permet de restreindre les types des liens entre les éléments de travail dans le projet d'équipe actuel.

  • ExternalLinkFilters : permet de restreindre 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 hypertexte ou les fichiers sous contrôle de version.

  • WorkItemTypeFilters : permet de restreindre les 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éfini dans le projet d'équipe actuel.

Dans chacun de ces éléments, vous pouvez spécifier des éléments Filter pour indiquer les types de liens ou les 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éfinir 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

               Regrouper

               Colonne

               Tabulation

                     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 de 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 qui créent des relations entre les é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 l'ensemble de types de liens fournis dans le jeu d'éléments Filter. L'élément est de type simple : LinksControlFilterKind.

Les valeurs valides que vous pouvez utiliser sont les suivantes :

  • exclude : permet d'interdire la création de liens à partir des types de liens répertoriés dans les éléments Filter.

  • excludeAll : permet d'interdire tous les types de liens.

  • include : permet d'autoriser uniquement les types de liens répertoriés dans les éléments Filter.

  • includeAll : permet d'autoriser la création de liens à partir de tous les types de liens.

Filter

 

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

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

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

 

LinkType

Attribut Filter requis.

Spécifie le nom de référence pour un type de lien. Les types valides sont les types de liens définis par le système suivants :

  • Storyboard

  • System.LinkTypes.Dependency

  • System.LinkTypes.Hierarchy

  • System.LinkTypes.Related

En outre, vous pouvez spécifier le nom de référence pour les types de liens personnalisés définis pour la collection de projets d'équipe. Pour plus d'informations, consultez Référence des éléments de type de lien.

 

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 les suivantes :

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

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

Si non spécifié, les noms direct et inverse sont utilisés pour filtrer le type de lien.

Notes

Si la topologie de type de lien est Réseau, les noms direct et inverse sont identiques.Pour plus d'informations, consultez Référence des éléments de type de lien.

ExternalLinkFilters

 

Élément LinksControlOptions facultatif.

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

 

FilterType

Attribut ExternalLinkFilters facultatif.

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

Vous pouvez utiliser les valeurs suivantes :

  • exclude : permet d'interdire la création de liens à partir des types de liens qui apparaissent dans les éléments Filter.

  • excludeAll : permet d'interdire tous les types de liens.

  • include : permet d'autoriser uniquement les types de liens répertoriés dans les éléments Filter.

  • includeAll : permet d'autoriser la création de liens à partir de tous les types de liens.

Si non spécifié, tous les liens vers des éléments de travail externes sont exclus.

Filter

 

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

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

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

Spécifie le nom des types de liens qui seront inclus dans l'ensemble de liens que les utilisateurs peuvent créer pour l'élément de travail, ou qui seront exclus de cet ensemble.

 

LinkType

Attribut Filter requis.

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

  • Corrigé dans l'ensemble de modifications

  • Pièce jointe de résultat

  • Fichier de code source

  • Résultat de test

  • Lien hypertexte d'é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.

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

 

Scope

Attribut WorkItemTypeFilters facultatif.

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

Les valeurs valides que vous pouvez utiliser sont les suivantes :

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

  • project : permet d'autoriser la création de liens uniquement pour les types d'éléments de travail définis pour le projet actuel.

Si non spécifié, des 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 l'ensemble de types d'éléments de travail fournis dans le jeu d'éléments Filter. L'élément est de type simple : LinksControlWorkItemTypeFilterKind.

Vous pouvez utiliser les valeurs suivantes :

  • exclude : permet d'interdire les types d'éléments de travail dans les éléments Filter.

  • excludeAll : permet d'interdire tous les types d'éléments de travail.

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

  • includeAll : permet d'autoriser tous les types d'éléments de travail.

Si vous ne spécifiez aucune de ces valeurs, des liens vers tous les types d'éléments de travail sont autorisés.

Filter

 

Élément WorkItemTypeFilters facultatif quand FilterType a la valeur exclude ou include.

Quand FilterType est excludeAll ou includeAll, vous ne devez pas spécifier d'éléments Filter.

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

 

WorkItemType

Attribut Filter requis.

Spécifie le nom de 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 requis.

Spécifie les champs d'élément de travail et les attributs de type de lien affichés pour la liste de 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 dans lequel les champs de colonne sont affichés 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 à un 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 régissent la création des relations avec d'autres éléments de travail selon le type de lien et, éventuellement, les noms direct et inverse des types de lien.

  • Spécifiez les restrictions qui régissent la création des relations avec des objets autres que des éléments de travail, tels que l'ensemble de modifications, le lien hypertexte, etc., selon les types de lien externe.

  • Spécifiez les restrictions qui régissent la création des relations avec d'autres éléments de travail selon le type d'élément de travail et, éventuellement, le projet d'équipe où sont définis ces éléments de travail.

  • Spécifiez les champs de colonne par défaut qui doivent afficher des informations pour la liste de liens.

Exemple

L'exemple suivant indique comment permettre la création de liens dont le type est Microsoft.VSTS.Common.TestedBy et afficher le Forward Name pour ce type de lien. Les options de filtre interdisent la création de liens vers tous les types de liens externes. En outre, 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 obtenir plus d'exemples, consultez Définir 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>

Boutons de barre d'outils LinksControl

Chaque élément Control de Type=”LinksControl” fournit une barre d'outils, qui contient les boutons figurant dans l'illustration suivante :

Contrôles de barre d'outils du lien du formulaire d'élément de travail

Ces boutons deviennent disponibles uniquement après l'exécution d'une action spécifique :

  • Le bouton permettant de créer un élément de travail lié à l'élément de travail ouvert (Icône Ajouter un nouvel élément de travail lié) devient disponible quand vous enregistrez l'élément de travail ouvert.

  • Les boutons permettant d'ouvrir la liste des éléments de travail dans une requête (Ouvrir dans une requête) et dans un client Microsoft Office (Ouvrir dans Office) deviennent disponibles quand au moins un élément de travail est répertorié sous l'onglet de contrôle des liens.

  • Les boutons permettant d'ouvrir un élément de travail (Ouvrir l'élément de travail), de modifier un lien (Modifier un lien) et de supprimer un lien (Supprimer le lien) ne deviennent disponibles qu'une fois que vous avez cliqué sur un ou plusieurs éléments de travail répertoriés sous l'onglet de contrôle des liens.

Le contrôle des liens affiché est le même pour Team Web Access et Team Explorer, sauf quand il est configuré pour afficher uniquement les liens Storyboard. Dans ce cas, la barre d'outils contient uniquement les contrôles permettant d'ajouter un nouveau lien, d'ouvrir l'élément lié et de supprimer le lien. De plus, la version de Team Web Access affiche le lien Démarrer les animations dans le menu de contrôle.

Contrôle des liens de plan conceptuel

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

Référence des éléments de type de lien

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

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

Autres ressources

Définir un type de lien personnalisé