Freigeben über

XML-Elementreferenz für FORM

  • Artikel

Die im vorliegenden Thema enthaltenen Informationen können als Kurzübersicht für alle Elemente und Hauptattribute genutzt werden, die das Formular für einen Typ von Arbeitsaufgabe steuern. Sie geben diese Elemente im FORM-Elementcontainer an, dem dritten und abschließenden Hauptabschnitt der Definition eines Arbeitsaufgabentyps. Viele Elemente werden in andere Elemente geschachtelt, sodass Gruppen, Abschnitte und Registerkarten in einem Arbeitsaufgabenformular gebildet werden. Weitere Informationen zum Gruppieren dieser Elemente finden Sie unter Entwerfen des Layouts des Arbeitsaufgabenformulars.

In diesem Thema

  • Beispiel für FORM

  • Syntax für FORM-Elemente

  • Attribute, die FORM-Elemente angeben

  • Elemente, die eigenständige Bezeichnungen, Links, Webseiten oder HTML-Inhalte angeben

  • Elemente, die Linkbeziehungen filtern und anzeigen

Beispiel für FORM

Im folgenden Beispiel wird die Gesamtstruktur des FORM-Elements veranschaulicht. Mit dem Layout-Element wird das Layout eines Formulars angegeben. Sie können unterschiedliche Layouts für verschiedene Clients festlegen. Beispielsweise können Sie ein Layout für Windows-Clients und ein anderes Layout für Team Web Access angeben. Ein Layout besteht in der Regel aus dem oberen Bereich des Formulars und einer Gruppe von Registerkarten. Die Reihenfolge, in der Sie die Elemente innerhalb des Layouts definieren, bestimmt die Reihenfolge, in der die Elemente im Formular angezeigt werden.

Mit dem Group-Element und dem Column-Element gruppieren Sie Elemente für die Anzeige in Spalten. Mithilfe des Control-Elements definieren Sie die einzelnen Felder, die im Formular dargestellt werden sollen. Sie verwenden das Tab-Element, um andere Funktionsbereiche von Feldgruppen zu unterstützen.

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

Formularelemente

Mit den in der folgenden Tabelle aufgeführten Elementen können Sie angeben, wie Informationen und Arbeitsaufgabenfelder gruppiert und in einem Arbeitsaufgabenformular angezeigt werden.

Tipp

Zum Optimieren der Ergebnisse empfiehlt es sich, Control-Elemente in einer Group zu schachteln. Außerdem sollten Group-Elemente in einer Column geschachtelt werden, auch wenn sich die Spalte über die normale Breite des Formulars erstreckt. Zudem sollten Sie jeden Column-Abschnitt in einen Group-Abschnitt schachteln, auch wenn die Gruppe über keine sichtbare Bezeichnung oder Begrenzung verfügt.

Element

Beschreibung

Erforderlich?

Column

Teilt die Bereiche eines Formulars in Spalten.

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

Empfohlen

Control

Definiert ein Feld, Text, einen Link oder ein anderes Steuerelement, das auf dem Arbeitsaufgabenformular angezeigt wird.

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

Weitere Informationen finden Sie unter XML-Elementreferenz für Control .

Erforderlich

FORM

Definiert das Formularelement der obersten Ebene.

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

Erforderlich

Group

Stellt ähnlich dem Windows GroupBox-Steuerelement eine visuelle Gruppierung von Elementen bereit.

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

Empfohlen

Layout

Definiert das Layout des Arbeitsaufgabenformulars.

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

Erforderlich

Splitter

Unterteilt ein Formular in zwei Bereiche und unterstützt das Layout von zwei gleichgeordneten Formularelementen.

Splitter Dock="Left" />

Optional

Tab

Definiert das Layout einer einzelnen Registerkarte in einer Gruppe von Registerkarten.

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

Optional

TabGroup

Definiert eine oder mehrere Registerkarten für das Formular.

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

Optional

Zurück nach oben

Attribute zum Formatieren von FORM-Elementen

Sie können Abstand und Größe vieler Elemente eines Arbeitsaufgabenformulars festlegen, indem Sie die in der folgenden Tabelle beschriebenen Attribute angeben. Weitere Informationen finden Sie unter Entwerfen des Layouts des Arbeitsaufgabenformulars.

Attribut

Beschreibung

Anwendbare Elemente

ControlSpacing

Optional. Gibt den vertikalen Offset von Steuerelementen an. Integer.

Layout

Dock

Optional. Streckt ein Feldsteuerelement oder eine Aufteilung, sodass der Container vollständig ausgefüllt wird. Gültige Werte zum Andocken von Feldern: Fill, Top, Bottom, Left und Right.

  • Fill: Richtet das Feld so aus, dass es den Container ausfüllt.

  • Top: Richtet das Feld am oberen Rand des Containers aus.

  • Bottom: Richtet das Feld am unteren Rand des Containers aus.

  • Left: Richtet das Feld oder den Splitter am linken Rand des Containers aus. Dieser Wert stellt die einzige unterstützte Ausrichtung für das SPLITTER-Element dar.

  • Right: Richtet das Feld oder den Splitter am rechten Rand des Containers aus.

Control

Splitter

FixedWidth

Optional. Die Spaltenbreite in Pixeln. PercentWidth und FixedWidth schließen einander aus.

Column

Label

Optional. Text, der für ein Steuerelement oder eine Gruppe angezeigt wird. Wenn eine Bezeichnung angegeben wird, wird dadurch jede andere Bezeichnung überschrieben, die dem Feld in den Metadaten für das Steuerelement zugeordnet ist.

Erforderlich für das Tab-Element. Text, der für eine Registerkarte angezeigt wird.

LabelText ist eine Textzeichenfolge mit 1 bis 80 Zeichen.

Control

Group

Tab

LabelPosition

Optional. Die Position der Bezeichnung relativ zu den Felddaten. Mögliche Werte sind Oben, Unten, Links und Rechts.

Control

LabelSpacing

Optional. Gibt die Anzahl von Pixeln zwischen der Bezeichnung und dem Bearbeitungsbereich des Steuerelements an.

Layout

Margin

Optional. Eine Zeichenfolge der Form (links, oben, rechts, unten), die den gewünschten Abstand um das Steuerelement sowie den Abstand zwischen dem Steuerelement und benachbarten Steuerelementen in Pixel angibt. Auf den einzelnen Seiten können unterschiedliche Abstände angegeben werden.

Musterwert: ^\(\d+\,\d+\,\d+\,\d+\)$

Musterwertbeispiel: (2,0,2,0)

Control

Group

Layout

Tab

TabGroup

MinimumSize

Optional. Zeichenfolge der Form (Breite, Höhe). Dieser Wert gibt die minimale Größe des Formulars an. Wenn das Containersteuerelement kleiner ist, werden horizontale und vertikale Bildlaufleisten angezeigt.

Control

Layout

Name

Optional. Der Name des Steuerelements. Falls kein Name angegeben wird, entspricht der Name FieldName.

Control

Padding

Optional. Eine Zeichenfolge der Form (links, oben, rechts, unten), die den gewünschten Abstand um den äußeren sowie den inneren Rahmen des Steuerelements in Pixeln angibt. Auf den einzelnen Seiten können unterschiedliche Abstände angegeben werden.

Control

Group

Layout

Tab

TabGroup

PercentWidth

Optional. Die Spaltenbreite als Prozentsatz der Breite des enthaltenden Elements. PercentWidth und FixedWidth schließen einander aus.

Column

ReadOnly

Optional. Sie können ein schreibgeschütztes Feld in einem Steuerelement anzeigen. Das Verhalten anderer Steuerelemente in Bezug auf dieses Attribut kann leicht variieren.

Control

Target

Optional. Zeichenfolge, die angibt, für welchen Client dieses Layout übernommen wird. Visual Studio zeigt diesen Arbeitsaufgabentyp in diesem Layout an, wenn das Target-Attribut ausgelassen oder auf Windows Forms festgelegt wird. Durch externe Clients können zusätzliche Layouts unter Verwendung benutzerdefinierter Target-Attribute angegeben werden, die von Visual Studio ignoriert werden.

Folgende Werte sind gültig:

  • WinForms: Übernimmt das Formular für Team Explorer und Team Explorer Everywhere 2010.

  • Web: Übernimmt das Formular für Team Web Access.

Layout

Type

Erforderlich. Der Typ des Steuerelements. Weitere Informationen finden Sie unter XML-Elementreferenz für Control.

Control

Zurück nach oben

Das WebpageControlOptions-Element und seine untergeordneten Elemente verfügen über die folgende Syntaxstruktur:

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

Mit den in der folgenden Tabelle beschriebenen Elementen können Sie Nur-Text- oder mit Links versehene Bezeichnungen definieren, einem Feld Links hinzufügen oder Webseiteninhalte in einem Arbeitsaufgabenformular anzeigen. Weitere Informationen finden Sie unter Bereitstellen von Hilfetexten, Prozessleitfäden, Webinhalten und Links zu Webseiten auf einem Arbeitsaufgabenformular.

Element

Erforderlich?

Beschreibung

Content

Optionales WebpageControlOptions-Element.

Gibt den CDATA HTML-Inhalt an, der in einem Arbeitsaufgabenformular angezeigt wird.

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

Weitere Informationen finden Sie unter XML-Elementreferenz für WebpageControlOptions.

LabelText

Optionales Control-Element, wenn type="LabelControl".

Definiert eine einfache oder mit einem Link versehene Bezeichnung.

Weitere Informationen finden Sie unter XML-Elementreferenz für LabelText und Text.

Link

Optionales Control-Element, wenn type="FieldControl".

Optionales Text-Element.

Optionales WebpageControl-Element.

Optionales WebpageControlOptions-Element.

Definiert den Link für ein Feld, eine Bezeichnung oder Webbrowserinhalt, die in einem Arbeitsaufgabenformular angezeigt werden.

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

Weitere Informationen finden Sie unter XML-Elementreferenz für Link und Param.

Param

Optionales Link-Element.

Gibt einen Wert an, mit dem die URL des Links bestimmt wird, wenn URLPath für das Link-Element angegeben ist.

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

Weitere Informationen finden Sie unter XML-Elementreferenz für Link und Param.

Text

Optionales LabelText-Element.

Containerelement für die Informationen oder die Bezeichnung, die im Arbeitsaufgabenformular angezeigt werden.

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

Weitere Informationen finden Sie unter XML-Elementreferenz für LabelText und Text.

WebpageControlOptions

Optionales Control-Element, wenn type="WebpageControl".

Containerelement, das die Optionen für das Webseiten-Steuerelement angibt.

Weitere Informationen finden Sie unter XML-Elementreferenz für WebpageControlOptions.

Zurück nach oben

Elemente, die Linkbeziehungen filtern und anzeigen

Mithilfe des LinksControlOptions-Elements definieren Sie die Optionen, mit denen festgelegt wird, welche Links einer Arbeitsaufgabe hinzugefügt werden können, sowie die Standardspalten, die für die Liste der Links in einer Arbeitsaufgabe angezeigt werden sollen. Wenn Sie einem Arbeitsaufgabenformular die Linksteuerung hinzufügen, können Sie Filter angeben, mit denen die von Benutzern erstellten Linktypen sowie die Arbeitsaufgabentypen eingeschränkt werden, zwischen denen Benutzer Links erstellen können. Das LinksControlOptions-Element und seine untergeordneten Elemente verfügen über die folgende Syntaxstruktur:

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

Dabei verwenden Sie die in der folgenden Tabelle zusammengefassten Elemente. Weitere Informationen zum Verwenden dieser Elemente finden Sie unter Definieren von Link-Steuerelementen zum Einschränken der Link-Beziehungen und LinksControlOptions-Elemente.

Element

Erforderlich?

Beschreibung

LinksControlOptions

Optionales Control-Element, wenn type="LinksControl".

Stellt einen Container für Elemente zum Definieren der Optionen bereit, mit denen festgelegt wird, welche Links einer Arbeitsaufgabe hinzugefügt werden können, sowie der Standardspalten, die für die Liste der Links in einer Arbeitsaufgabe angezeigt werden sollen.

WorkItemLinkFilters

Optionales LinksControlOptions-Element.

Stellt einen Container für ein oder mehrere Filter-Elemente bereit, die die Kriterien zum Filtern von Links angeben, die auf Linktypen angewendet werden sollen, die für die Teamprojektsammlung definiert sind.

ExternalLinkFilters

Optionales LinksControlOptions-Element.

Stellt einen Container für ein oder mehrere Filter-Elemente bereit, die die Filterkriterien für Linktypen angeben, die in anderen Teamprojekten definiert sind.

WorkItemTypeFilters

Optionales LinksControlOptions-Element.

Stellt einen Container für ein oder mehrere Filter-Elemente bereit, die die Filterkriterien angeben, die auf Arbeitsaufgabentypen angewendet werden sollen.

Filter (Linktypen)

Erforderliches WorkItemLinkFilters-Element, wenn das FilterType-Attribut exclude oder include ist.

Erforderliches ExternalLinkFilters-Element, wenn das FilterType-Attribut exclude oder include ist.

Gibt die Typen von Links an, die in die Gruppe der Links eingeschlossen bzw. von dieser ausgeschlossen werden sollen, die für die Arbeitsaufgabe erstellt werden können.

Filter (Arbeitsaufgabentypen)

Optionales WorkItemTypeFilters-Element, wenn das FilterType-Attribut exclude oder include ist.

Gibt die Typen von Arbeitsaufgaben an, die in die Gruppe der Arbeitsaufgabentypen eingeschlossen bzw. von dieser ausgeschlossen werden sollen, zwischen denen Benutzer Links erstellen können.

LinkColumns

Optionales LinksControlOptions-Element.

Stellt einen Container für einen oder mehrere LinkColumn-Tags bereit.

LinkColumn

Erforderliches LinkColumns-Element.

Gibt die Arbeitsaufgabenfelder und Linktypattribute an, die im Arbeitsaufgabenformular für die Liste der Links angezeigt werden sollen.

Zurück nach oben

Siehe auch

Konzepte

Entwerfen des Layouts des Arbeitsaufgabenformulars

Entwerfen und Anpassen eines Arbeitsaufgabenformulars

Weitere Ressourcen

Index für XML-Elementdefinitionen für Arbeitsaufgabentypen

Änderungsprotokoll

Datum

Versionsgeschichte

Grund

Mai 2011

Die Schreibweise mehrerer Elemente und Attribute der XML-Syntax wurde korrigiert. In der Schemadefinition für die Nachverfolgung von Arbeitsaufgaben werden alle untergeordneten Elemente des FORM-Elements mit Binnenversalien definiert und alle Buchstaben in den Namen sämtlicher anderer Elemente nur in Großschreibung dargestellt.

Korrektur inhaltlicher Fehler.

Januar 2011

Beispiel und Syntax für alle FORM-Elemente hinzugefügt. Links zu nicht mehr vorhandenen Themen wurden entfernt.

Informationsergänzung.

Juli 2010

Links zu Themen hinzugefügt, die im vorherigen Update hinzugefügt wurden.

Informationsergänzung.