Share via

Référence des éléments XML Control

  • Article

Vous utilisez l'élément Control pour définir un champ, un texte, un lien hypertexte ou tout autre élément de contrôle à afficher dans un formulaire d'élément de travail. Pour obtenir des exemples d'utilisation de cet élément, consultez Spécification des contrôles de formulaire d'élément de travail. Pour plus d'informations, consultez Conception et personnalisation d'un formulaire d'élément de travail.

Hiérarchie de schéma

WITD

   WORKITEMTYPE

       FORM

           Disposition

               Groupe

               Colonne

               Onglet

<xs:element name="Control" type="ControlType" minOccurs="0"/>

<Control FieldName="FieldName" Type="AttachmentsControl | DateTimeControl | FieldControl | 
HtmlFieldControl | LabelControl | LinksControl | WebpageControl | WorkItemClassificationControl | 
WorkItemLogControl" Label="LabelText" LabelPosition="Top | Bottom | Left | Right" 
Dock="Fill | Top | Bottom | Left | Right" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" ReadOnly="True | False" MinimumSize="(width,height)" 
Name="InstanceName" >
<LabelText> . . . </LabelText>
<Link> . . . </Link>
<LinksControlOptions> . . . </LinksControlOptions>
<WebpageControlOptions> . . . </WebpageControlOptions>
</Control>

Attributs et éléments

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

Attributs

Attribut

Description

FieldName

Attribut ControlType facultatif.

Spécifie le champ d'élément de travail auquel le contrôle est associé. Le type de l'attribut est typelib:ReferenceFieldName. Longueur minimale : 1 ; longueur maximale : 70.

Valeur de modèle : ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

Exemple de valeur de modèle : Company.Division.IssueType

Type

Attribut ControlType requis.

Spécifie le type de données du contrôle. Le type d'attribut est le type simple ValidControlsType. Spécifiez une chaîne de l'un des types intégrés suivants :

  • AttachmentControl: Utilisez pour afficher des pièces jointes d'élément de travail. Ce contrôle n'a pas de champ ou type de champ associé.

  • DateTimeControl: Utilisez pour afficher des champs Date mis en forme avec un type de champ de DateTime.

  • FieldControl: Utilisez pour afficher les champs numériques ou textuels ordinaires et les listes de valeurs pour les champs avec les types String, Identity, Integer, Double et PlainText.

  • HtmlFieldControl: Utilisez pour afficher le format de texte riche de champs, multiligne avec un type de champ HTML.

  • LabelControl: Utilisez pour afficher le texte qui n'est pas associé à un champ. Le texte peut être brut ou hypertexte.

  • LinksControl: Utilisez pour afficher des liens d'élément de travail. Ce contrôle n'a pas de champ ou type de champ associé.

  • WebpageControl: Utilisez pour afficher le contenu HTML défini par un URI ou incorporé dans une balise CDATA. Ce contrôle n'a pas de champ ou type de champ associé.

  • Utilisation de WorkItemClassificationControl pour afficher les champs de chemin d'accès hiérarchiques avec un type de champ TreePath.

    RemarqueRemarque
    Les champs System.AreaPath et System.IterationPath sont les seuls champs qui utilisent ce type de données.Vous ne pouvez pas définir de champ personnalisé à l'aide de ce type de données.

  • WorkItemLogControl: Utilisez pour afficher des informations d'historique d'élément de travail et des champs avec un type de champ de History.

    RemarqueRemarque
    Le champ System.History est le seul champ qui utilise ce type de données.Vous ne pouvez pas définir de champ personnalisé à l'aide de ce type de données.

Pour plus d'informations, consultez Spécification des contrôles de formulaire d'élément de travail.

RemarqueRemarque
Vous pouvez utiliser un contrôle personnalisé en attribuant à l'attribut Type une valeur personnalisée.Tout contrôle dont la valeur Type ne correspond pas au nom d'un type intégré est considéré comme un contrôle personnalisé.Pour plus d'informations, consultez le site Web Microsoft : Contrôles personnalisés de suivi d'élément de travail (éventuellement en anglais).

Label

Attribut ControlType facultatif.

Spécifie le texte visible sur le formulaire qui identifie le contrôle. Spécifiez une chaîne de moins de 80 caractères.

LabelPosition

Attribut ControlType facultatif.

Spécifie la position de l'étiquette par rapport aux données du contrôle. Spécifiez une chaîne de l'une des valeurs suivantes :

  • Top : place l'étiquette au-dessus de données de contrôle.

  • Bottom : place l'étiquette au-dessous des données de contrôle.

  • Left : place l'étiquette à gauche des données de contrôle.

  • Right : place l'étiquette à droite des données de contrôle.

Dock

Attribut ControlType facultatif.

Aligne le champ sur le côté spécifié du conteneur ou étire le champ pour remplir le conteneur. Le type de l'attribut est DockType. Spécifiez une chaîne de l'une des valeurs suivantes :

  • Fill : Aligne le champ de sorte qu'il remplisse le conteneur. Cette valeur n'est pas une orientation prise en charge pour l'élément Splitter.

  • Top: Aligne le champ avec le haut du conteneur. Cette valeur n'est pas une orientation prise en charge pour l'élément Splitter.

  • Bottom: Aligne le champ avec le fond du conteneur. Cette valeur n'est pas une orientation prise en charge pour l'élément Splitter.

  • Left: Aligne le champ avec le côté gauche du conteneur.

  • Right: Aligne le champ avec le côté droit du conteneur. Cette valeur n'est pas une orientation prise en charge pour l'élément Splitter.

Padding

Attribut ControlType facultatif.

Spécifie la quantité d'espace en pixels autour de la bordure intérieure du contrôle qui correspond aux espaces supérieur, inférieur, gauche et droite. Le type de l'attribut est SizeType.

Valeur de modèle : ^\(\d+\,\d+\,\d+\,\d+\)$

Exemple de valeur de modèle : (2,0,2,0)

Margin

Attribut ControlType facultatif.

Spécifie la quantité d'espace en pixels autour de la bordure extérieure du contrôle qui correspond aux espaces supérieur, inférieur, gauche et droite. Le type de l'attribut est SizeType.

Valeur de modèle : ^\(\d+\,\d+\,\d+\,\d+\)$

Exemple de valeur de modèle : (2,0,2,0)

ReadOnly

Attribut ControlType facultatif.

Spécifie que le champ est en lecture seule. Le type de l'attribut est ReadOnlyType. Spécifiez une chaîne de l'une des valeurs suivantes :

  • True : spécifie que les données du contrôle sont en lecture seule.

  • False : spécifie que les données de contrôle ne sont pas en lecture seule.

MinimumSize

Attribut ControlType facultatif.

Spécifie la taille minimale en pixels que le contrôle doit occuper dans le formulaire. La syntaxe est spécifiée dans (width,height). Le type de l'attribut est SizeType.

Valeur de modèle : ^\(\d+\,\d+\)$

Exemple de valeur de modèle : (100,100)

RemarqueRemarque
Si vous n'avez pas un espace vertical suffisant, une barre de défilement semble garder sa taille minimale.Sans cet attribut, les contrôles sont dessinés avec leur taille par défaut, à moins que des contrôles d'autres onglets n'occupent un espace plus important.La taille générale d'un contrôle de formulaire dépend de la taille de la zone ou de l'onglet du formulaire le plus grand.

Name

Attribut ControlType facultatif.

Identifie un contrôle de manière unique. L'attribut Name est important si plusieurs contrôles du formulaire sont associés au même champ d'élément de travail. Le type de l'attribut est xs:string.

RemarqueRemarque
Vous utilisez l'attribut Name lorsque vous souhaitez que le même champ s'affiche dans plusieurs emplacements sur le formulaire.Vous spécifiez une valeur unique pour l'attribut Name des deux entrées de contrôle afin que le système identifie chaque contrôle de manière unique.Il est utile d'afficher le même contrôle à différents emplacements en fonction du contexte des onglets.

NumberFormat

Attribut ControlType facultatif qui est valide uniquement lorsqu'il est utilisé avec FieldControl.

Spécifie les caractères que vous pouvez entrer dans le contrôle de champ. Les valeurs valides que vous pouvez utiliser sont les suivantes :

  • WholeNumbers: Spécifie que les nombres entiers sont autorisés.

  • SignedWholeNumbers: Spécifie que les nombres entiers signés sont autorisés.

  • DecimalNumbers: Spécifie que les nombres décimaux sont autorisés.

  • SignedDecimalNumbers: Spécifie que les nombres décimaux signés sont autorisés.

MaxLength

Attribut ControlType facultatif qui est valide uniquement lorsqu'il est utilisé avec FieldControl.

Spécifie la longueur maximale de caractères autorisés pour un contrôle Field. Le type de l'attribut est xs:integer.

Format

Attribut ControlType facultatif qui est valide uniquement lorsqu'il est utilisé avec DateTimeControl.

Spécifie le format du champ date-heure correspondant à l'une des valeurs de l'enum DateTimePickerFormat. Les valeurs valides que vous pouvez utiliser sont les suivantes :

  • Custom: Affiche la valeur de date/d'heure dans un format personnalisé. Le format Personnalisé peut être défini en spécifiant « Personnalisé » comme valeur pour l'attribut de formatage et en définissant un autre attribut nommé CustomFormat avec une chaîne de format personnalisée. Par exemple :

    Format="Custom"

    CustomFormat = « dd MMM, 'de l'année' yyyy »

    Pour plus d'informations, consultez le site Web Microsoft : DateTimePicker.CustomFormat, propriété.

  • Long : affiche la valeur de date/heure dans le format de date longue défini par le système d'exploitation de l'utilisateur.

  • Short : affiche la valeur de date/heure dans le format de date courte défini par le système d'exploitation de l'utilisateur.

  • Time : affiche la valeur de date/heure dans le format d'heure défini par le système d'exploitation de l'utilisateur.

Pour plus d'informations, consultez le site Web de Microsoft : DateTimePickerFormat, énumération.

CustomFormat

Attribut ControlType facultatif qui est valide uniquement lorsqu'il est utilisé avec l'attribut DateTimeControl et Format.

Spécifie le format personnalisé du champ date-heure correspondant à la syntaxe définie pour la propriété DateTimePicker.CustomFormat. Pour plus d'informations, consultez le site Web Microsoft : DateTimePicker.CustomFormat, propriété.

Éléments enfants

Élément

Description

LabelText

Élément facultatif. Vous pouvez spécifier cet élément lorsque ControlType est spécifié comme FieldControl ou LabelControl.

Élément conteneur permettant de spécifier le texte, le lien hypertexte et la position d'un champ ou d'une étiquette dont le texte est associé en partie à un lien hypertexte.

Pour plus d'informations, consultez Référence des éléments XML LabelText et Text et Ajout de texte d'aide, guide de processus, contenu Web et liens vers les pages Web sur un formulaire d'élément de travail.

Link

Élément facultatif. Vous pouvez spécifier cet élément lorsque ControlType est spécifié comme FieldControl ou LabelControl.

Définit le lien hypertexte pour un champ ou une étiquette.

Pour plus d'informations, consultez Référence des éléments XML Link et Param et Ajout de texte d'aide, guide de processus, contenu Web et liens vers les pages Web sur un formulaire d'élément de travail.

LinksControlOptions

Élément facultatif. Vous pouvez spécifier cet élément lorsque ControlType est spécifié comme LinksControl.

Définit les filtres de liens et la disposition des champs de colonne de façon à afficher la liste des liens.

Pour plus d'informations, consultez Définition des contrôles de liens pour restreindre les relations de liens.

WebpageControlOptions

Élément facultatif. Vous pouvez spécifier cet élément lorsque ControlType est WebpageControl.

Spécifie les contrôles qui déterminent le chargement de la page Web cible dans le formulaire d'élément de travail.

Pour plus d'informations, consultez Référence des éléments XML WebpageControlOptions et Ajout de texte d'aide, guide de processus, contenu Web et liens vers les pages Web sur un formulaire d'élément de travail.

anyAttribute

Élément facultatif.

Facultatif. ControlType est extensible via l'utilisation de l'élément anyAttribute. ProcessContents : skip.

Éléments parents

Élément

Description

Disposition

Obligatoire. Définit comment afficher les éléments sur le formulaire d'élément de travail.

Élément Column

Obligatoire. Définit les colonnes du formulaire.

Élément Tab

Obligatoire. Définit un onglet du formulaire.

Notes

Control est un élément enfant facultatif de Layout, Column et Tab.

Indicateurs Layout et Column :

minOccurs = "0"

maxOccurs = "1"

Indicateurs Tab :

minOccurs = "0"

maxOccurs = "unbounded"

Pour implémenter un contrôle personnalisé, vous devez spécifier le nom du contrôle pour l'attribut Type. Pour plus d'informations, consultez le site Web Microsoft : Contrôles personnalisés de suivi d'élément de travail (éventuellement en anglais).

Pour obtenir un exemple de chaque type de contrôle, consultez Spécification des contrôles de formulaire d'élément de travail.

Exemple

<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
  Label="Area" LabelPosition="Left" />

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

Type complexe ControlType

Peut être vide

Non applicable

Voir aussi

Concepts

Conception et personnalisation d'un formulaire d'élément de travail

Référence de tous les éléments XML FORM

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

Historique des modifications

Date

Historique

Motif

Janvier 2011

Éléments enfants ajoutés à la syntaxe et liens supprimés ou remplacés vers les rubriques qui ont été supprimées.

Améliorations apportées aux informations.