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

Article
06/09/2015

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écifier des contrôles de formulaire d'élément de travail et Concevoir le formulaire d'élément de travail.

Hiérarchie de schéma

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

<Control FieldName="FieldName" Type="AttachmentsControl | DateTimeControl | FieldControl | 
HtmlFieldControl | LabelControl | LinksControl | WebpageControl | WorkItemClassificationControl | 
WorkItemLogControl" ControlFontSize="FontSize" EmptyText="TextString"
Label="LabelText" LabelPosition="Top | Bottom | Left | Right" 
Padding="(top, bottom, left, right)" 
Margin="(top, bottom, left, right)" 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 Control 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 Control 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 : utilisé pour afficher des pièces jointes aux éléments de travail. Ce contrôle n'a pas de champ ni de type de champ associé. DateTimeControl : utilisé pour afficher des champs Date mis en forme avec un type de champ DateTime. FieldControl : utilisé 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 : utilisé pour afficher le format RTF multiligne des champs qui ont un type de données de champ HTML. LabelControl : utilisé pour afficher un texte qui n'est pas associé à un champ. Le texte peut être brut ou hypertexte. Vous pouvez spécifier des contrôles supplémentaires à l'aide des éléments LabelText, Link et Text. Consultez Référence des éléments XML LabelText et Text et Référence des éléments XML Link et Param. LinksControl : utilisé pour afficher la barre d'outils de contrôle des liens et gérer les relations de liens entre les éléments de travail et les animations. Ce contrôle n'a pas de champ ni de type de champ associé. Vous spécifiez les types de liens à filtrer et d'autres options de contrôle à l'aide de l'élément LinksControlOptions. Consultez Éléments LinksControlOptions. WebpageControl : utilisé pour afficher le contenu HTML défini par un URI ou incorporé dans une balise CDATA. Ce contrôle n'a pas de champ ni de type de champ associé. . Vous spécifiez le contenu et les liens à afficher à l'aide de l'élément WebpageControlOptions. Consultez Référence des éléments XML WebpageControlOptions. WorkItemClassificationControl : utilisé pour afficher les champs de chemin d'accès hiérarchiques avec un type de champ TreePath. Notes 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 : utilisé pour afficher des informations d'historique des éléments de travail et des champs avec un type de champ History. Notes 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écifier des contrôles de formulaire d'élément de travail. Notes Vous pouvez utiliser un contrôle personnalisé en affectant une valeur personnalisée à l'attribut Type.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 de Microsoft : Contrôles personnalisés de suivi des éléments de travail.
ControlFontSize	Attribut Control facultatif. Spécifie la taille de police du nom de champ ou de l'étiquette sur le formulaire. Valeurs valides de FontSize: small, normal, large, xlarge et xxlarge.
EmptyText	Attribut Control facultatif. Spécifie une chaîne de texte d'une longueur de 1 à 255 caractères, qui apparaît lorsqu'un champ est vide.
Label	Attribut Control 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.
LabelFontSize	Spécifie la taille de police de l'étiquette sur le formulaire. Valeurs valides pour FontSize: small, normal, large, xlarge et xxlarge.
LabelPosition	Attribut Control facultatif. Spécifie la position de l'étiquette par rapport aux données du contrôle. Spécifiez une chaîne à partir de l'une des valeurs suivantes : Top : place l'étiquette au-dessus des 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.
Padding	Attribut Control 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 Control 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 Control facultatif. Spécifie que le champ est en lecture seule. Le type de l'attribut est ReadOnlyType. Spécifiez une chaîne à partir de l'une des valeurs suivantes : True : indique que les données du contrôle sont en lecture seule. False : indique que les données de contrôle ne sont pas en lecture seule.
MinimumSize	Attribut Control 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) Notes Si vous n'avez pas un espace vertical suffisant, une barre de défilement s'affiche pour conserver 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 Control 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. Notes 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 Control 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 : indique que les nombres entiers sont autorisés. SignedWholeNumbers : indique que les nombres entiers signés sont autorisés. DecimalNumbers : indique que les nombres décimaux sont autorisés. SignedDecimalNumbers : indique que les nombres décimaux signés sont autorisés.
MaxLength	Attribut Control 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 Control 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 Format 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 de Microsoft : Propriété DateTimePicker.CustomFormat. 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 : Énumération DateTimePickerFormat.
CustomFormat	Attribut Control 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 de Microsoft : Propriété DateTimePicker.CustomFormat.

Éléments enfants

Élément	Description
LabelText	Élément facultatif. Vous pouvez spécifier cet élément lorsque l'attribut Type 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 en partie associé à un lien hypertexte. Pour plus d’informations, consultez Référence des éléments XML LabelText et Text et Fournir du texte d'aide, des liens hypertexte ou du contenu Web sur un formulaire d'élément de travail.
Link	Élément facultatif. Vous pouvez spécifier cet élément lorsque l'attribut Type 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 Fournir du texte d'aide, des liens hypertexte ou du contenu Web sur un formulaire d'élément de travail.
LinksControlOptions	Élément facultatif. Vous pouvez spécifier cet élément lorsque l'attribut Type 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éfinir des contrôles de liens pour restreindre les relations de liens.
WebpageControlOptions	Élément facultatif. Vous pouvez spécifier l'élément lorsque l'attribut Type est WebpageControl. Spécifie les contrôles qui déterminent le chargement de la cible de la page web dans le formulaire d'élément de travail. Pour plus d’informations, consultez Référence des éléments XML WebpageControlOptions et Fournir du texte d'aide, des liens hypertexte ou du contenu Web sur un formulaire d'élément de travail.
anyAttribute	Élément facultatif. Facultatif. Control est extensible via l'utilisation de l'élément anyAttribute.

É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 de Microsoft : Contrôles personnalisés de suivi des éléments de travail.

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

Exemple

<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
  Label="Area" LabelPosition="Left" Padding="(2,0,2,0)" Margin="(2,2,2,2)" />

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