Angeben von Steuerelementen für Arbeitselementformulare

Azure DevOps Server 2022 | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Fügen Sie für jedes Feld oder Formularsteuerelement, das Sie in einem Arbeitselementformular anzeigen möchten, ein Control Element hinzu. Ein Arbeitsaufgabenformular kann angepasst werden, um Informationen anzuzeigen, die das Team bei der richtigen Verwendung des Formulars unterstützen. Sie können Arbeitsaufgabenfelder und -steuerelemente hinzufügen, die das Eingeben und Anzeigen der Daten ermöglichen, die nachverfolgt werden sollen.

Das Control Element stellt mehrere Datentypwerte für das Type Attribut bereit, das Sie zum Hinzufügen von Feldern oder zum Anzeigen von nur oder verknüpften Text oder Feldern verwenden können. Zudem können Sie spezielle Steuerelemente zum Hinzufügen von Links und Anlagen und zum Anzeigen von webbasiertem Inhalt definieren, oder ein eigenes Steuerelement erstellen, das Sie einem Arbeitselementformular hinzufügen.

Sie können im Arbeitsaufgabenformular den Bezeichnungsnamen, die Position und die Größe des Textfelds sowie weitere Anzeigesteuerelemente von Nur-Text-, Ganzzahl-, Zahlen-, Datums- und Strukturpfad-Arbeitsaufgabenfeldern steuern. Um diese Felder anzuzeigen, müssen Sie das richtige Control Elementattribute Type aus den folgenden Optionen angeben:

  • FieldControl: Wird verwendet, um nur textbezogene oder numerische Felder und Listen von Werten für Felder anzuzeigen, die einen Feldtyp von Boolean, String, Identity, IntegerDouble, und PlainText.

  • HtmlFieldControl: Wird verwendet, um mehrlinieniges, Rich-Text-Format von Feldern anzuzeigen, die einen Felddatentyp HTMLaufweisen.

  • DateTimeControl: Wird verwendet, um formatierte Datumsfelder anzuzeigen, die einen Feldtyp aufweisen DateTime.

  • WorkItemClassificationControl Wird verwendet, um die hierarchischen Pfadfelder anzuzeigen, die einen Feldtyp aufweisen TreePath.

Hinzufügen von Arbeitselementfeldern

Wenn Sie das Arbeitselementformular anpassen, fügen Sie in der Regel eine Teilmenge der für den Arbeitselementtyp definierten Arbeitselementfelder ein, die auf dem Formular angezeigt werden sollen. Die Felddefinitionen steuern viele Aspekte davon, welche Daten angezeigt werden oder welche Daten in das Formular eingegeben werden können. Weitere Informationen finden Sie unter Ändern eines Felds oder Hinzufügen eines benutzerdefinierten Felds.

Jedes Arbeitselementfeld ist einem Datentyp zugeordnet. Verwenden Sie das Label Attribut, um den Text anzugeben, der neben dem Steuerelement angezeigt wird. Verwenden Sie das zugehörige LabelPosition Attribut, um anzugeben, wo die Bezeichnung relativ zum Steuerelement angezeigt wird.

Hinweis

Sie können die Werte von Systemfeldern nicht ändern, die automatisch aktualisiert werden. Beispielsweise werden die Felder „Erstellungsdatum“ und „Erstellt von“ definiert, wenn ein Arbeitselement zum ersten Mal gespeichert wird. Sie können diese Felder jedoch als Suchkriterien verwenden. Eine Beschreibung jedes Systemfelds finden Sie unter Arbeitselementfeldindex.

Hinzufügen eines numerischen Felds

Dient FieldControl zum Bereitstellen eines Steuerelementfelds für ein Integer-Feld.

<Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />

Wird verwendet FieldControl , um ein Textfeld für die Eingabe oder Anzeige von Double-Feldern bereitzustellen.

<Control FieldName="ABC_Company.Statistics.Analysis" Type="FieldControl" Label="Analysis %" LabelPosition="Left" />

Hinzufügen eines Nur-Text- oder Zeichenfolgenfelds

Geben Sie das String Steuerelement an, wenn Sie ein Zeichenfolgenfeld hinzufügen möchten, z. B. in Auswahllisten oder kurzem Text, das auf 255 Zeichen beschränkt ist.

<Control FieldName="Microsoft.VSTS.DocName" Type="FieldControl" Label="Vision Doc Location" LabelPosition="Left" />

Geben Sie das PlainText Steuerelement an, wenn Sie Text erfassen möchten, der Beschreibungen enthält, die größer als 255 Zeichen sein können.

<Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />

Hinzufügen eines Kontrollkästchens oder eines booleschen Felds

Hinweis

Featureverfügbarkeit: Der boolesche Datentyp wird für gehostetes XML (Azure DevOps Services) und für lokales XML, für TFS 2017.2 und höhere Versionen unterstützt.

Verwenden Sie die folgende Syntax, um ein boolesches Feld innerhalb des FIELDS-Abschnitts der WIT-Definition hinzuzufügen.

<FIELD name="Triage" refname="Fabrikam.Triage" type="Boolean" >
  <DEFAULT from="value" value="False" />
  <HELPTEXT>Triage work item</HELPTEXT>
</FIELD>

Fügen Sie dann die folgende Syntax im FORMULAR-Abschnitt hinzu, damit das Feld im Formular angezeigt wird.

<Control Label="Triage" Type="FieldControl" FieldName="Fabrikam.Triage" /> 

Das Feld wird als Kontrollkästchen im Formular angezeigt.

Hinzufügen von Datums- oder Kalenderfeldern

Sie verwenden den DateTimeControl Typ, um Benutzern eine Kalenderauswahl zu geben, um ein Datum für ein DateTime Feld auszuwählen. Mit diesem Steuerelement können Sie schnell ein Datum und eine Uhrzeit für das Feld auswählen.

Kalenderfeld mit Format="Short"
Kalenderfeld

Sie können z. B. ein bevorzugtes Anfangsdatum oder ein Reviewdatum angeben, das in der Zukunft liegt.

<Control Type="DateTimeControl" FieldName="MyCompany.EnvironmentCR.PreferredStart"  
Label="Preferred Start Date:" LabelPosition="Left" Format="Short" />  
<Control Type="DateTimeControl" FieldName="MyCompany.EnvironmentCR.PreferredStartTime"  
Label="Preferred Start Time:" LabelPosition="Left" Format="Time" />  

Sie können das Format des DateTime Felds steuern, indem Sie die optionalen Attribute verwenden, die in der folgenden Tabelle beschrieben werden.

Attribut BESCHREIBUNG
Format Gibt das Format für das Datums-/Uhrzeitfeld an, das einem Wert der DateTimePickerFormat-Enumeration entspricht. Gültige Werte sind wie folgt: Custom, Long, Short, . Time

Wenn Sie angeben Custom, müssen Sie auch das CustomFormat Attribut festlegen.
CustomFormat Gibt das benutzerdefinierte Format für das Datums-/Uhrzeitfeld an, das der für die DateTimePicker.CustomFormat-Eigenschaft definierten Syntax entspricht. Beispiel:

Format="Custom"

CustomFormat = "MMM tt, 'des Jahres' jjjj"

Weitere Informationen finden Sie auf der Microsoft-Website: DateTimePicker.CustomFormat-Eigenschaft.

Hinzufügen eines Rich-Text-Felds (HTML)

Geben Sie das HTMLControl Feld zum Erfassen von Rich-Text-Formatierungen HTML an, wie in der folgenden Abbildung dargestellt.

<Control Type="HtmlFieldControl" FieldName="Microsoft.VSTS.Notes" Label="Notes" Dock="Fill" />

HTML-Feld, das im Arbeitselementformular ALM_WIT_Custom_HTMLField angezeigt wird

Tipp

Wenn Sie mehrere HTMLFieldControl Elemente in einem Formular hinzufügen, das vertikal gestapelt wird, sollten Sie das MinimumSize Attribut für jedes Feldsteuerelement angeben. Auf diese Weise können Sie Textfelder mit jeweils ähnlicher Größe erstellen. Andernfalls wird die Größe des letzten HTML-Steuerelements angepasst, um das Formular auszufüllen, und die vorherigen Elemente werden zusammen mit kleineren Textfeldern angezeigt.

Hinzufügen eines einfachen oder hyperlinkierten Textsteuerelements

Verwenden Sie das LabelControl Anzeigen von nur oder verknüpftem Text, der nicht einem Feld zugeordnet ist, wie in der folgenden Abbildung dargestellt.

Sie verwenden die LabelTextLink untergeordneten und containerelemente, um den Text, den Hyperlink und die Position eines Felds oder einer Beschriftung anzugeben, deren Text teilweise einem Hyperlink zugeordnet ist. Weitere Informationen finden Sie unter Bereitstellen von Hilfetext, Hyperlinks oder Webinhalten, LabelText und Text sowie Link und Param.

Beispiel für zwei Links, die auf Text WIT_SS_HyperlinkComboLabel angewendet wurden

Hinzufügen eines Webseitensteuerelements

Wird verwendet WebpageControl, um Webinhalte in einem Arbeitselementformular anzuzeigen. Dieses Steuerelement ist normalerweise in einer eigenen Registerkartengruppe enthalten. Sie verwenden die WebpageControlOptions untergeordneten Link Elemente, um die Steuerelemente anzugeben, die zum Laden des Webseitenziels im Arbeitselementformular erforderlich sind.

Weitere Informationen finden Sie unter Bearbeiten einer WIT-Definition zum Hinzufügen von Webinhalten zu einem Arbeitselementformular, WebseitenControlOptions und Link und Param.

Sie verwenden LinksControl das Erstellen und Verwalten von Verknüpfungen zwischen Arbeitselementen. Dieses Steuerelement ist normalerweise in einer eigenen Gruppe von Registerkarten enthalten, wie in der folgenden Abbildung gezeigt.

Beispiel für das Verknüpfungssteuerelement, das einem Arbeitselementformular WIT_SS_LinksControl hinzugefügt wurde

Sie können auch die LinksControlOptions Verknüpfungsfilter und das Layout von Spaltenfeldern definieren, die zum Anzeigen der Liste der Links verwendet werden. Weitere Informationen finden Sie unter Definieren von Verknüpfungssteuerelementen zum Einschränken von Verknüpfungsbeziehungen und LinksControlOptions.

Hinzufügen eines Storyboards-Steuerelements

StoryboardsControl Öffnen Sie PowerPoint Storyboarding aus einer Arbeitsaufgabe, und verknüpfen Sie sie mit Storyboarddateien, die in einer Netzwerkfreigabe gespeichert sind. Dieses Steuerelement ist normalerweise in einer eigenen Gruppe von Registerkarten enthalten, wie in der folgenden Abbildung gezeigt.

Storyboardlinks-Steuerelement

Um den StoryboardsControlFORM Abschnitt hinzuzufügen, fügen Sie den folgenden Codeausschnitt hinzu:

<Tab Label="Storyboards">
     <Control Name="StoryboardsControl" Type="LinksControl">
        <LinksControlOptions>
           <WorkItemLinkFilters FilterType="excludeAll" />
           <ExternalLinkFilters FilterType="include">
              <Filter LinkType="Storyboard" />
           </ExternalLinkFilters>
           <LinkColumns>
              <LinkColumn RefName="System.Title" />
              <LinkColumn LinkAttribute="System.Links.Comment" />
           </LinkColumns>
        </LinksControlOptions>
     </Control>
  </Tab>

Hinzufügen von Bereichs- und Iterationspfaden (TreePath-Steuerelement)

Sie verwenden den WorkItemClassificationControl Typ, um Felder hinzuzufügen, deren Datentyp ist TreePath. Dieses Steuerelement unterstützt das Anzeigen von Feldern für den Bereichspfad und den Iterationspfad in einem hierarchischen, verschachtelten Strukturformat. Die Struktur enthält hierarchische Knoten, die erweitert und reduziert werden können.

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

Hinweis

Mit der WorkItemClassificationControl Anzeige der Felder können Sie die System.IterationPathSystem.AreaPath Felder anzeigen. Mit diesem Steuerelement können keine andere Feldtypen benutzerdefinierte Felder angezeigt werden.

Hinzufügen des Verlaufssteuerelements

Sie verwenden das WorkItemLogControl Steuerelementfeld für das Feld "Verlauf", das Diskussionsthreads und andere historische Informationen verfolgt, wie in der folgenden Abbildung dargestellt.

Registerkarte

Dieses Steuerelement kann nur zur Unterstützung der Anzeige des Verlaufsfelds eines Arbeitselements, des Arbeitselementfelds „System.History“, verwendet werden. Mithilfe dieses Steuerelements können Sie Details zu Verlaufsrevisionen einem Arbeitselement erweitern und reduzieren. Zudem können Sie einen Text, den Sie dem Verlaufsfeld hinzufügen, formatieren.

<Control Type="WorkItemLogControl" FieldName="System.History" Label="Detailed Description and History" LabelPosition="Top" Dock="Fill" />

Hinzufügen des Anlagensteuerelements

Verwenden Sie die AttachmentsControl Datei zum Anfügen von Dateien an ein Arbeitselementformular. Dieses Steuerelement ist normalerweise in einer eigenen Gruppe von Registerkarten enthalten, wie in der folgenden Abbildung gezeigt.

Anfügen von Dateien an eine Arbeitsaufgabe

Weitere Informationen finden Sie unter Hinzufügen des Attachments-Steuerelements.

Zusätzlich zu den integrierten Steuerelementen finden Sie möglicherweise zusätzliche Steuerelemente, die Sie aus dem Visual Studio Marketplace verwenden können. Oder Sie können ihr eigenes Steuerelement erstellen. Weitere Informationen finden Sie unter "Erweitern des Arbeitselementformulars".

Bezeichnen von Feldern und Hinzufügen von Feldern an zwei Stellen im Formular

Für jedes Formularsteuerelement können Sie eine optionale Beschriftung und die Position der Beschriftung mithilfe der und LabelPosition der Label Attribute angeben. Die Bezeichnung kann einen anderen Namen als den Anzeigenamen angeben, der vom FIELD Element zugewiesen wird. Wenn Sie keine Bezeichnung angeben, wird der Anzeigename verwendet. Beachten Sie jedoch, dass der Anzeigename immer verwendet wird, wenn ein Teammitglied eine Abfrage ausführt, um nach Arbeitsaufgaben zu suchen. Eine Bezeichnung darf höchstens 80 Zeichen umfassen.

Hinweis

Für alle in derselben Gruppe definierten Steuerelemente muss dieselbe Bezeichnungsposition festgelegt werden.

Wenn Sie das Feld in mehr als einem Bereich des Formulars hinzufügen möchten, z. B. oben im Formular und auf einer Registerkarte, können Sie dies mithilfe des Name Attributs tun. Das Name Attribut identifiziert das Steuerelement nur als anders als das andere Steuerelement, das dem Formular hinzugefügt wird.

Erstellen eines schreibgeschützten Felds

Sie können zwei verschiedene Methoden verwenden, um ein Feld als schreibgeschützt zu markieren. In der ersten Methode fügen Sie das READONLY Element als untergeordnetes Element zum FIELD Element im FIELDS Abschnitt der Typdefinition hinzu. Mithilfe des READONLY Elements können Sie angeben, ob bestimmte Benutzer das Feld ändern können. Nur Programmmanager können ein Untertitelfeld ändern (siehe folgendes Beispiel).

<FIELD name="Sub-Title" refname="ACME.ACE.SubTitle" type="String" >  
<READONLY for="[Global]\Team Foundation Valid Users" not="Program Managers"/>  
</FIELD>  

In der zweiten Methode geben Sie das ReadOnly Attribut für das CONTROL Element an. Bei dieser Methode darf kein Benutzer das Feld ändern.

<Control FieldName=" ACME.ACE.SubTitle" Type="FieldControl" Label="Sub-Title" LabelPosition="Left" ReadOnly="True" />  

Optionale Steuerelementfeldattribute für alle Steuerelementtypen

Die folgenden optionalen Attribute können nur für die aufgeführten Steuerelementtypen angegeben werden.

Hinweis

Die Gesamtgröße der einzelnen Dateneingabefelder wird mithilfe mehrerer Faktoren bestimmt: die dem Feld zugewiesenen Attribute, der Größe des Containers und des Bereichs, der anderen Feldern im Formular zugeordnet wird. Wenn Sie keine Mindestgröße angeben, werden den Feldern Standardwerte zugewiesen. Die den anderen Feldern im Formular zugewiesenen Attribute können sich jedoch auf die Größe der Felder auswirken. Die dem größten Feld der einzelnen Spalten zugeordnete Anzahl an Spalten und horizontale Größe bestimmen die horizontale Abmessung eines Formulars. Die Anzahl der für eine vertikale Gruppe angegebenen Felder sowie die den einzelnen Feldern zugeordnete vertikale Größe bestimmen oben und unten im Formular dessen Größe.

Attribut BESCHREIBUNG
Field Gibt das Steuerelement an, das dem Arbeitselementfeld zugeordnet ist.
Label Gibt den sichtbaren Text auf dem Formular an, mit dem das Steuerelement identifiziert wird. Geben Sie eine Zeichenfolge mit höchstens 80 Zeichen an.

Hinweis: Sie können einen Hyperlink mit der Beschriftung eines Felds anfügen, das dem Arbeitselementformular hinzugefügt FieldControlwird. Dieses Steuerelement ist nützlich für das Bereitstellen eines Links, um auf Informationen über die Verwendung des Felds zuzugreifen. Weitere Informationen finden Sie unter Bereitstellen von Hilfetext, Hyperlinks oder Webinhalten.
LabelPosition Gibt die Position der Bezeichnung relativ zu den Steuerelementdaten an. Geben Sie eine Zeichenfolge aus einem der folgenden Werte an: Top, Bottom, Left, und Right.
Dock Gibt die Ausrichtung der Bezeichnung nach der angegebenen Seite des Containers an oder streckt das Feld, damit es den Container ausfüllt. Geben Sie eine Zeichenfolge aus einem der folgenden Werte an: Fill, Top, Bottom, , Left, und Right.
Padding Gibt den Platz um den inneren Rahmen des Steuerelements in Pixeln an. Vier Werte werden bereitgestellt, die oben, unten, links und rechts entsprechen. Zum Beispiel: (2,0,2,0).
Margin Gibt den Platz um den äußeren Rahmen des Steuerelements in Pixeln an. Vier Werte werden bereitgestellt, die oben, unten, links und rechts entsprechen. Zum Beispiel: (2,0,2,0).
ReadOnly Gibt an, dass das Feld schreibgeschützt ist. Geben Sie True oder False an.
MinimumSize Gibt die minimale Größe in Pixel an, die das Steuerelement im Formular einnehmen sollte. Zwei Werte werden angegeben, die der Breite und der Höhe entsprechen. Zum Beispiel: (100,100).
Name Identifiziert ein Steuerelement auf eindeutige Weise. Das Name Attribut ist erforderlich, wenn mehrere Steuerelemente im Formular demselben Arbeitselementfeld zugeordnet sind.

Hinweis: Sie verwenden das Name Attribut, um dasselbe Feld in mehreren Bereichen im Formular anzuzeigen. Sie geben einen eindeutigen Wert für das Name Attribut für beide Steuerelementeinträge an, sodass das System jedes Steuerelement eindeutig identifiziert. Es ist nützlich, dasselbe Steuerelement basierend auf dem Kontext der Registerkarten an verschiedenen Positionen anzuzeigen.

Optionale Steuerelementfeldattribute für spezifische Steuerelementtypen

Die folgenden optionalen Attribute können nur für die aufgeführten Steuerelementtypen angegeben werden.

Attribut Steuerelementtypen BESCHREIBUNG
NumberFormat FieldControl Gibt die Zeichen an, die Sie im Feldsteuerelement eingeben können. Die folgenden Werte sind gültig: WholeNumbers, SignedWholeNumbers, DecimalNumbers, und SignedDecimalNumbers.
MaxLength FieldControl Gibt die maximale Länge von Zeichen an, die Sie für ein Feldsteuerelement verwenden können.
Format DateTimeControl Gibt das Format für das Datums-/Uhrzeitfeld an, das einem Wert der DateTimePickerFormat-Enumeration entspricht. Die folgenden Werte sind gültig: Custom, Long, Short, Time.
CustomFormat DateTimeControl Gibt das benutzerdefinierte Format für das Datums-/Uhrzeitfeld an, das der für die DateTimePicker.CustomFormat-Eigenschaft definierten Syntax entspricht.