Partager via

Référence des éléments XML Link et Param

  • Article

L'élément Link permet d'ajouter un lien hypertexte à un champ ou une étiquette autonome sur un formulaire d'élément de travail. L'élément Link dans les instances ci-dessous permet d'effectuer les opérations suivantes :

  • Ajouter un lien hypertexte à une étiquette de champ

  • Ajouter un lien hypertexte à une étiquette autonome ou à des parties de texte informatif

  • Spécifier l'URL du contenu à afficher dans un formulaire d'élément de travail

Pour ajouter des éléments à un formulaire, vous modifiez la définition d'un type d'élément de travail. Consultez Modifier ou ajouter un type d'élément de travail personnalisé (WIT).

L'élément Link est un élément enfant de l'élément Control, ou un élément enfant des éléments WebpageControlTarget ou WebpageControlOptions. Pour plus d'informations sur ces éléments, consultez Référence des éléments XML Control et Référence des éléments XML WebpageControlOptions.

Hiérarchie de schéma

WITD

   WORKITEMTYPE

       FORM

           Disposition

               Regrouper

               Colonne

               Tabulation

                     Contrôle

<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param Index="IndexValue " Value="ParamValue " Type ="Original | Current"/>
</Link>

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

Link

 

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

Élément LabelText facultatif.

Élément Text facultatif.

Élément WebpageControlOptions facultatif.

Élément conteneur pour la définition d'un lien hypertexte ou d'une URL. L'élément est de type complexe : HyperLinkType.

 

UrlRoot

Attribut Link requis.

Spécifie le protocole et le nom de serveur de l'URL à laquelle l'étiquette est liée. Les protocoles pris en charge sont HTTP, HTTPS et MAILTO.

Vous pouvez soit coder en dur le nom de serveur spécifié, soit utiliser l'une des macros suivantes, en y ajoutant éventuellement des informations d'adresse supplémentaires :

Notes

Chaque macro lie à l'URL définie et activée pour le projet d'équipe du formulaire d'élément de travail pour lequel l'élément Link est défini.Si l'une des ressources n'est pas fournie ou activée pour le projet d'équipe, le message d'erreur « Page introuvable » s'affiche.

  • @PortalPage : URL du site SharePoint pour le projet d'équipe actuel (par exemple, http://nom_serveur/sites/Nom_collection/Nom_projet_équipe).

  • @ProcessGuidance : URL du site SharePoint pour le guide de processus pour un projet d'équipe.

  • @ReportManagerUrl : URL du serveur qui héberge le Gestionnaire de rapports pour le projet d'équipe actuel. Cela fournit un lien vers l'affichage des dossiers pour les rapports (par exemple, https://serverName/Reports/Pages/Folder.aspx?ItemPath=/Nom_collection/Nom_projet_équipe).

  • @ReportServiceSiteUrl : URL du serveur qui héberge SQL Server Reporting Services pour le projet d'équipe actuel, plus le chemin d'accès de base pour le projet d'équipe (par exemple, http://nom_serveur/Reports/Pages/ReportService.asmx ?L'élément ItemPath = /Nom_collection/Nom_projet_équipe).

Pour déterminer la valeur codée en dur pour les deux premières macros, vous pouvez ouvrir les paramètres du portail du projet pour un projet d'équipe. Pour plus d'informations, consultez Configurer ou rediriger un guide de processus.

L'attribut est de type simple : NonBlankString.

 

UrlPath

Attribut Link facultatif.

Spécifie un chemin d'accès d'URL pour le lien hypertexte. Cet attribut permet de spécifier des paramètres variables déterminés au moment de l'exécution. L'attribut est de type simple : NonBlankString.

Param

 

Élément Link facultatif. Requis si UrlPath est spécifié.

Spécifie une valeur à utiliser pour déterminer l'URL du lien hypertexte lorsque UrlPath est spécifié.

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

 

Index

Attribut Param requis.

Spécifie l'index du paramètre où la valeur doit être mise en forme dans la chaîne d'URL. Il n'est pas obligatoire pour classer les valeurs d'index de façon séquentielle. Toutefois, il doit correspondre au numéro de l'index dans la chaîne URLPath.

Le type de l'attribut est PositiveInteger. Le premier numéro d'index doit être 0.

 

Value

Attribut Param requis.

Spécifie le nombre associé à la valeur d'un chemin d'accès d'URL pour le lien hypertexte.

Spécifie une valeur qui doit être mise en forme dans la chaîne URLPath. Les valeurs doivent être des noms valides de références de champs utilisés dans la définition du type d'élément de travail.

La variable @Me est prise en charge. Elle est remplacée par le nom du membre de l'équipe qui consulte actuellement le formulaire d'élément de travail. Les entrées de valeur ne respectent pas la casse.

Le type de l'attribut est xs:string.

 

Type

Attribut Param facultatif.

Spécifie que la valeur d'origine du champ doit être utilisée pour le paramètre. L'attribut est de type simple : HyperLinkParamValueKind.

Les valeurs valides sont les suivantes :

  • Original : spécifie que la valeur de paramètre d'origine doit être utilisée pour déterminer le chemin d'accès de l'URL.

  • Current : spécifie que la valeur de paramètre actuelle doit être utilisée pour déterminer le chemin d'accès de l'URL.

Si cet attribut n'est pas spécifié, la valeur actuelle du champ est utilisée comme paramètre.

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

LabelText

Élément Control facultatif.

Élément conteneur pour afficher une étiquette sur le formulaire d'élément de travail.

Texte

Élément LabelText facultatif.

Élément conteneur pour les informations ou l'étiquette à afficher sur le formulaire d'élément de travail.

WebpageControlOptions

Élément Control facultatif.

Élément conteneur qui spécifie les options pour le contrôle de page web.

Pour plus d'informations, consultez Affichage de contenu web dans un formulaire d'élément de travail.

Notes

Le comportement par défaut de l'élément Link consiste à ouvrir le lien hypertexte dans le formulaire d'élément de travail ou la page web. Si le lien hypertexte est créé pour s'ouvrir dans une nouvelle fenêtre (target="_blank"), un navigateur externe est ouvert.

Vous pouvez combiner du texte ordinaire et hypertexte en ajoutant plusieurs éléments Text dans un élément LabelText.

L'élément LabelText est reconnu uniquement par les clients qui exécutent la dernière version Team Explorer. Par conséquent, vous devez spécifier l'attribut Label dans un élément Control lorsque vous spécifiez un élément Link enfant. Pour les clients qui exécutent la version la plus récente de Team Explorer, le texte fourni par un élément LabelText s'affiche dans le formulaire d'élément de travail. Pour les clients qui exécutent des versions antérieures de Team Explorer, le texte spécifié par l'attribut Control de l'élément Label s'affiche dans le formulaire d'élément de travail.

Exemple : spécification d'un lien hypertexte avec des paramètres

Description

L'exemple suivant montre comment définir un lien hypertexte qui renvoie au guide de processus pour la rubrique Iteration :

http://nom_serveur/sites/nom_collection/nom_projet/render.aspx?wit=bug&amp;topic=Iteration

Le nom du projet est dérivé de la valeur affectée au champ System.Project.

Code

<Link UrlRoot="https://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&amp;topic=Iteration">
   <Param Index="0" Value="System.Project" />
</Link>

Exemple : ajout d'un lien hypertexte à une étiquette autonome

Description

L'exemple suivant montre comment assigner un lien hypertexte au texte « work item guidance » (aide concernant les éléments de travail) sur un formulaire d'élément de travail.

Code

<Control type="LabelControl">
   <LabelText> 
      <Text>
         <Link UrlRoot="https://www.msn.com" />
      work item guidance
      </Text>
   </LabelText> 
</Control>

Exemple : ajout d'un lien hypertexte à un champ

Description

L'exemple suivant montre comment ajouter un lien hypertexte à l'étiquette d'un champ sur un formulaire d'élément de travail.

Code

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="This text comes from the Label attribute:">
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
         This text comes from the inner Label Text
      </Text>
   </LabelText>
</Control>

Définitions de schéma

  • HyperLinkType

  • NonBlankString

  • HyperLinkParamType

  • HyperLinkParamValueKind

Type complexe : HyperLinkType

<xs:complexType name="HyperLinkType" >
   <xs:sequence>
      <xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
   <xs:attribute name="UrlRoot"  type="NonBlankString" use="required" />
   <xs:attribute name="UrlPath"  type="NonBlankString" use="optional" />
</xs:complexType>

HyperLinkParamType

<xs:complexType name="HyperLinkParamType" >
   <xs:attribute name="Index"     type="PositiveInteger" use="required" />
   <xs:attribute name="Value"     type="xs:string" use="required" />
   <xs:attribute name="Type" type="HyperLinkParamValueKind" use="optional" />
</xs:complexType>

NonBlankString

<xs:simpleType name="NonBlankString">
   <xs:restriction  base="xs:string">
   <xs:pattern value=".*\S+.*"/>
   </xs:restriction>
</xs:simpleType>

HyperLinkParamValueKind

<xs:simpleType name="HyperLinkParamValueKind">
   <xs:restriction base="xs:string">
   <xs:enumeration value="Original"/>
   <xs:enumeration value="Current"/>
   </xs:restriction>
</xs:simpleType>

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

HyperLinkType, HyperLinkParamType

Peut être vide

Non applicable

Voir aussi

Concepts

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

Concevoir le formulaire d'élément de travail