Share via

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

  • Article

Vous pouvez utiliser les informations de cette rubrique comme une référence rapide à tous les éléments et aux principaux attributs qui contrôlent le formulaire d'un type d'élément de travail. Vous spécifiez ces éléments dans le conteneur d'éléments FORM, la troisième et dernière section de la définition d'un type d'élément de travail. De nombreux éléments sont imbriqués les uns dans les autres pour former des groupes, des sections ou des onglets dans un formulaire d'élément de travail. Pour plus d'informations sur le regroupement de ces éléments, consultez Définition de la disposition du formulaire d'élément de travail.

Dans cette rubrique

  • Exemple FORM

  • Syntaxe pour les éléments FORM

  • Attributs spécifiés par les éléments FORM

  • Éléments qui spécifient des étiquettes, des liens hypertexte, des pages Web ou du contenu HTML autonomes

  • Éléments qui filtrent et affichent des relations de liens

Exemple FORM

L'exemple suivant illustre la structure globale de l'élément FORM. Vous spécifiez la disposition d'un formulaire à l'aide de l'élément Layout. Vous pouvez spécifier différentes dispositions qui ciblent différents clients. Par exemple, vous pouvez spécifier une disposition pour les clients Windows et une disposition différente pour Team Web Access. Une disposition se compose généralement du haut du formulaire, puis d'un groupe d'onglets. L'ordre dans lequel vous définissez les éléments dans la disposition détermine l'ordre dans lequel les éléments s'affichent sur le formulaire.

Vous regroupez les éléments pour qu'ils s'affichent dans des colonnes à l'aide des éléments Column et Group. Vous utilisez un élément Control pour définir chaque champ que vous souhaitez faire apparaître sur le formulaire. Vous utilisez l'élément Tab pour prendre en charge différentes zones fonctionnelles de groupes de champ.

<FORM>
      <Layout>
        <Group>
          <Column PercentWidth="70">
            <Group>
              <Column PercentWidth="100">
                <Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />
                <Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />
                <Control FieldName="System.IterationPath" Type="WorkItemClassificationControl" Label="&amp;Iteration Path:" LabelPosition="Left" />
                <Group>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.ProductUnit" Type="FieldControl" Label="PU (Use Area Path)" LabelPosition="Left" />
                  </Column>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.Priority" Type="FieldControl" Label="Priority" LabelPosition="Left" />
                  </Column>
                </Group>
              </Column>
            </Group>
          </Column>
          <Column PercentWidth="30">
            <Group Label="Status">
              <Column PercentWidth="100">
                <Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />
                <Control FieldName="System.State" Type="FieldControl" Label="State" LabelPosition="Left" />
                <Control FieldName="System.AssignedTo" Type="FieldControl" Label="Assigned To" LabelPosition="Left" />
              </Column>
            </Group>
          </Column>
        </Group>

. . .
</Layout>
</FORM>

Éléments Form

Vous pouvez spécifier le mode de regroupement et d'affichage des informations et des champs d'élément de travail dans un formulaire d'élément de travail à l'aide des éléments décrits dans le tableau suivant.

Notes

Pour obtenir les meilleurs résultats possibles, imbriquez les éléments Control dans Group et les éléments Group dans Column, même si la colonne couvre toute la largeur du formulaire. Il est également recommandé d'imbriquer chaque section Column dans Group, même si le groupe n'a aucune étiquette ou limite visible.

Élément

Description

Obligatoire ?

Column

Divise les zones d'un formulaire en colonnes.

<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Column >

Recommandé

Control

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.

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

Pour plus d'informations, consultez Référence des éléments XML Control.

Obligatoire

FORM

Définit l'élément du formulaire de niveau supérieur.

<FORM>
   <Layout> . . . </Layout>
</FORM>

Obligatoire

Group

Fournit un regroupement visuel des éléments, semblable à Windows GroupBox.

<Group Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)">
   <Column> . . . </Column>
</Group >

Recommandé

Layout

Définit la disposition du formulaire d'élément de travail.

<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance">
   <Group> . . . </Group>
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Layout>

Obligatoire

Splitter

Divise un formulaire en deux zones pour prendre en charge la disposition de deux éléments de formulaire frères.

Splitter Dock="Left" />

Facultatif

Tab

Définit la disposition d'un onglet unique dans un groupe d'onglets.

<Tab Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Tab>

Facultatif

TabGroup

Définit un ou plusieurs onglets pour le formulaire.

<TabGroup Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)">
   <Tab> . . . </Tab>
</TabGroup>

Facultatif

Retour au début

Attributs utilisés pour mettre en forme des éléments FORM

Vous pouvez contrôler l'espacement et la taille de nombreux éléments dans un formulaire d'élément de travail en spécifiant les attributs décrits dans le tableau suivant. Pour plus d'informations, consultez Définition de la disposition du formulaire d'élément de travail.

Attribut

Description

Éléments applicables

ControlSpacing

Facultatif. Spécifie le décalage vertical des contrôles. Integer.

Layout

Dock

Facultatif. Étire un contrôle de champ ou un séparateur pour remplir le reste du conteneur. Les valeurs d'ancrage de champ valides sont les suivantes : Fill, Top, Bottom, Left et Right.

  • Fill : Aligne le champ de sorte qu'il remplisse le conteneur.

  • Top : Aligne le champ avec le haut du conteneur.

  • Bottom : Aligne le champ avec le bas du conteneur.

  • Left : Aligne le champ ou le séparateur avec le côté gauche du conteneur. Cette valeur est la seule orientation prise en charge pour l'élément SPLITTER.

  • Right : Aligne le champ ou le séparateur avec le côté droit du conteneur.

Control

Splitter

FixedWidth

Facultatif. Largeur de la colonne en pixels. PercentWidth et FixedWidth s'excluent mutuellement.

Column

Label

Facultatif. Texte à afficher pour un contrôle ou un groupe. Si une étiquette est spécifiée, elle remplace toute étiquette associée au champ dans les métadonnées pour le contrôle.

Obligatoire pour l'élément Tab. Texte à afficher pour un onglet.

LabelText est une chaîne de texte qui contient entre 1 et 80 caractères.

Control

Group

Tab

LabelPosition

Facultatif. Position de l'étiquette par rapport aux données du champ. Les valeurs possibles sont Top, Bottom, Left et Right.

Control

LabelSpacing

Facultatif. Spécifie le nombre de pixels entre l'étiquette et la région d'édition du contrôle.

Layout

Margin

Facultatif. Chaîne se présentant sous la forme (gauche, haut, droite, bas) qui spécifie, en pixels, la quantité d'espace autour du contrôle et entre le contrôle et ses voisins. Vous pouvez varier la quantité d'espace sur chaque côté.

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

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

Control

Group

Layout

Tab

TabGroup

MinimumSize

Facultatif. Chaîne se présentant sous la forme (largeur, hauteur). Cette valeur spécifie la taille minimale du formulaire lui-même. Lorsque le contrôle conteneur est plus petit que cette taille, des barres de défilement horizontale et verticale apparaissent.

Control

Layout

Name

Facultatif. Nom du contrôle. S'il n'est pas spécifié, le nom est identique au FieldName.

Control

Padding

Facultatif. Chaîne se présentant sous la forme (gauche, haut, droite, bas) qui spécifie, en pixels, la quantité d'espace autour des bordures externe et interne du contrôle. Vous pouvez varier la quantité d'espace sur chaque côté.

Control

Group

Layout

Tab

TabGroup

PercentWidth

Facultatif. Largeur de colonne en tant que pourcentage de la largeur de l'élément conteneur. PercentWidth et FixedWidth s'excluent mutuellement.

Column

ReadOnly

Facultatif. Vous pouvez afficher un champ en lecture seule dans un contrôle. Divers contrôles réagissent à cet attribut de manière légèrement différente.

Control

Target

Facultatif. Chaîne spécifiant le client auquel cette présentation s'applique. Visual Studio affiche ce type d'élément de travail dans cette disposition si l'attribut Target est omis ou a pour valeur Windows Forms. Les clients externes peuvent spécifier des dispositions supplémentaires à l'aide d'attributs Target personnalisés que Visual Studio ignore.

Les valeurs suivantes sont valides :

  • WinForms : Applique le formulaire à Team Explorer et à Team Explorer Everywhere.

  • Web : Applique le formulaire à Team Web Access.

Layout

Type

Obligatoire. Type du contrôle. Pour plus d'informations, consultez Référence des éléments XML Control.

Control

Retour au début

Éléments qui spécifient des étiquettes, des liens hypertexte, des pages Web ou du contenu HTML autonomes

L'élément WebpageControlOptions et ses éléments enfants ont la structure de syntaxe suivante :

<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
   <Link UrlRoot="UrlRoot" UrlPath ="UrlPathWithParameters">
      <Param index="IndexValue" value="ParamValue" type ="Original | Current"/>
   </Link>
   <Content>
      <![CDATA[Contents of HTML]]>
   </Content>
</WebpageControlOptions>

Utilisez les éléments décrits dans le tableau suivant pour définir des étiquettes en texte brut ou hypertextes, ajouter des liens hypertexte à un champ ou afficher le contenu d'une page Web dans un formulaire d'élément de travail. Pour plus d'informations, consultez Ajout de texte d'aide, guide de processus, contenu Web et liens vers les pages Web sur un formulaire d'élément de travail.

Élément

Obligatoire ?

Description

Content

Élément WebpageControlOptions facultatif.

Spécifie le contenu HTML CDATA à afficher dans un formulaire d'élément de travail.

<Content>
   <![CDATA[Contents of HTML]]>
</Content>

Pour plus d'informations, consultez Référence des éléments XML WebpageControlOptions.

LabelText

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

Définit une étiquette brute ou hypertexte.

Pour plus d'informations, consultez Référence des éléments XML LabelText et Text.

Link

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

Élément Text facultatif.

Élément WebpageControl facultatif.

Élément WebpageControlOptions facultatif.

Définit le lien hypertexte pour un contenu de champ, d'étiquette ou de navigateur Web à afficher dans un formulaire d'élément de travail.

<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param />
</Link>

Pour plus d'informations, consultez Référence des éléments XML Link et Param.

Param

Élément Link facultatif.

Spécifie une valeur pour déterminer l'URL du lien hypertexte lorsque URLPath est spécifié pour l'élément Link.

<Param index="IndexValue " value="ParamValue " type ="Original | Current"/>

Pour plus d'informations, consultez Référence des éléments XML Link et Param.

Text

Élément LabelText facultatif.

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

<Text>
   <Link >
      <Param />
   </Link>
   LabelText
</Text>

Pour plus d'informations, consultez Référence des éléments XML LabelText et Text.

WebpageControlOptions

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

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

Pour plus d'informations, consultez Référence des éléments XML WebpageControlOptions.

Retour au début

Éléments qui filtrent et affichent des relations de liens

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 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 créer et les types d'éléments de travail entre lesquels les utilisateurs peuvent créer des liens. L'élément LinksControlOptions et ses éléments enfants ont la structure suivante :

<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="referenceName" | LinkAttribute="linkAttributeName"/>
   </LinkColumns>
</LinksControlOptions>

Plus particulièrement, vous utilisez les éléments résumés dans le tableau suivant. 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 et Éléments LinksControlOptions.

Élément

Obligatoire ?

Description

LinksControlOptions

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

Fournit un conteneur pour les éléments qui définissent 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.

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.

ExternalLinkFilters

É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 dans d'autres projets d'équipe.

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.

Filter (types de liens)

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

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

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

Filter (types d'éléments de travail)

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

Spécifie les types d'éléments de travail à inclure ou exclure du jeu des types d'éléments de travail entre lesquels les utilisateurs peuvent créer des liens.

LinkColumns

Élément LinksControlOptions facultatif.

Fournit un conteneur pour une ou plusieurs balises LinkColumn.

LinkColumn

Élément LinkColumns obligatoire

Spécifie les champs d'élément de travail et les attributs de type de lien à afficher sur le formulaire d'élément de travail pour la liste de liens.

Retour au début

Voir aussi

Concepts

Définition de la disposition du formulaire d'élément de travail

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

Autres ressources

Index des définitions d'éléments XML pour les types d'éléments de travail

Historique des modifications

Date

Historique

Motif

Mai 2011

La casse de plusieurs éléments et attributs de la syntaxe XML a été corrigée. 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 met en majuscule toutes les lettres qui composent les noms de tous les autres éléments.

Résolution des bogues de contenu.

Janvier 2011

Exemple ajouté et syntaxe pour tous les éléments FORM. Liens retirés vers les rubriques qui ont été supprimées.

Améliorations apportées aux informations.

Juillet 2010

Ajout des liens vers les rubriques ayant été ajoutées lors de la mise à jour précédente.

Améliorations apportées aux informations.