Freigeben über

XML-Elementreferenz für Link und Param

  • Artikel

Sie können einem Feld oder einer eigenständigen Bezeichnung in einem Arbeitsaufgabenformular mit dem Link-Element einen Link hinzufügen. Das Link-Element wird in den folgenden Instanzen für diese Zwecke verwendet:

  • Einer Feldbezeichnung einen Link hinzufügen

  • Einer eigenständigen Bezeichnung oder Teilen von Informationstext einen Link hinzufügen

  • URL für Inhalt angeben, der innerhalb eines Arbeitsaufgabenformulars angezeigt werden soll

Um Elemente zu einem Formular hinzuzufügen, ändern Sie die Definition eines Arbeitsaufgabentyps. Siehe Anpassen oder Hinzufügen eines benutzerdefinierten Arbeitsaufgabentyps (WIT).

Das Link-Element ist entweder ein untergeordnetes Element des Control-Elements oder ein untergeordnetes Element des WebpageControlTarget- oder WebpageControlOptions-Elements. Weitere Informationen zu diesen Elementen finden Sie unter Steuern des XML-Elementverweises und XML-Elementreferenz für WebpageControlOptions.

Schemahierarchie

WITD

   WORKITEMTYPE

       FORM

           Layout

               Gruppe

               Spalte

               Registerkarte

                     Steuerelement

<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">    <Param Index="IndexValue " Value="ParamValue " Type ="Original | Current"/> </Link>

Attribute und Elemente

In den folgenden Abschnitten werden Attribute sowie untergeordnete und übergeordnete Elemente beschrieben.

Untergeordnete Elemente und Attribute

Element

Attribut

Beschreibung 

Link

 

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

Optionales LabelText-Element.

Optionales Text-Element.

Optionales WebpageControlOptions-Element.

Containerelement zum Definieren eines Links oder einer URL. Der Elementtyp ist der komplexe Typ: HyperLinkType.

 

UrlRoot

Erforderliches Link-Attribut.

Gibt das Protokoll und den Servernamen der URL an, auf die die Bezeichnung verweist. Unterstützte Protokolle sind HTTP, HTTPS und MAILTO.

Sie können den angegebenen Servernamen hart codieren, oder Sie können eines der folgenden Makros verwenden und weitere Adressinformationen optional an ein Makro anfügen:

Hinweis

Jedes Makro wird mit der URL verknüpft, die für das Teamprojekt des Arbeitselementformulars definiert und aktiviert ist, für das das Link-Element definiert wurden.Wenn eine der Ressourcen nicht bereitgestellt oder für das Teamprojekt aktiviert wird, tritt der Fehler "Seite nicht gefunden" auf.

  • @PortalPage: Die URL der SharePoint-Website für das aktuelle Teamprojekt (z. B. https://Servername/sites/Auflistungsname/Teamprojektname).

  • @ProcessGuidance: Die URL der SharePoint-Website für die Prozessführung für ein Teamprojekt.

  • @ReportManagerUrl: Die URL des Servers, der den Berichts-Manager für das aktuelle Teamprojekt hostet. Dies stellt einen Link für die Berichte (z. B. https://serverName/Reports/Pages/Folder.aspx?ItemPath=/Auflistungsname/Teamprojektname) zur Ordneransicht bereit.

  • @ReportServiceSiteUrl: Die URL des Servers, der SQL Server Reporting-Dienste für das aktuelle Teamprojekt hostet, plus Basispfad des Teamprojekts (z. B. https://Servername/Reports/Pages/reportservice.asmx?ItemPath=/Auflistungsname/Teamprojektname).

Um den hartcodierten Wert für die ersten zwei Makros zu bestimmen, können Sie die Projektportaleinstellungen für ein Teamprojekt öffnen. Weitere Informationen finden Sie unter Konfigurieren oder Umleiten eines Prozessleitfadens.

Der Attributtyp ist ein einfacher Typ: NonBlankString.

 

UrlPath

Optionales Link-Attribut.

Gibt einen URL-Pfad für den Link an. Sie geben variable Parameter, die zur Laufzeit bestimmt werden, mithilfe dieses Attributs an. Der Attributtyp ist ein einfacher Typ: NonBlankString.

Param

 

Optionales Link-Element. Erforderlich, wenn UrlPath angegeben ist.

Gibt einen Wert an, mit dem die URL des Links bestimmt wird, wenn UrlPath angegeben ist.

Der Elementtyp ist der komplexe Typ: HyperLinkParamType.

 

Index

Erforderliches Param-Attribut.

Gibt den Index des Parameters an, wobei der Wert in die URL-Zeichenfolge formatiert werden muss. Es ist nicht erforderlich, die Indexwerte sequenziell anzufordern, sie müssen jedoch zur Nummer des Indexes in der URLPath-Zeichenfolge passen.

Der Attributtyp ist PositiveInteger. Die erste Indexzahl muss 0 sein.

 

Value

Erforderliches Param-Attribut.

Gibt die Zahl an, die dem Wert für einen URL-Pfad für den Link zugeordnet ist.

Gibt einen Wert an, der in die URLPath-Zeichenfolge formatiert werden muss. Werte müssen gültige Verweisnamen von Feldern sein, die in der Typdefinition der Arbeitsaufgabe verwendet wurden.

Die @Me-Variable wird unterstützt. Sie wird durch den Namen des aktuellen Teammitglieds ersetzt, das das aktuelle Arbeitsaufgabenformular anzeigt. Bei Werteinträgen wird keine Groß-/Kleinschreibung berücksichtigt.

Der Attributtyp ist xs:string.

 

Type

Optionales Param-Attribut.

Gibt an, dass der ursprüngliche Wert des Felds für den Parameter verwendet werden muss. Der Attributtyp ist ein einfacher Typ: HyperLinkParamValueKind.

Gültige Werte sind:

  • Original: Gibt an, dass der originale Parameterwert zum Bestimmen des URL-Pfads verwendet werden soll.

  • Current: Gibt an, dass der aktuelle Parameterwert zum Bestimmen des URL-Pfads verwendet werden soll.

Wenn dieses Attribut nicht angegeben ist, wird der aktuelle Wert des Felds als Parameter verwendet.

Übergeordnete Elemente

Element

Beschreibung 

Steuerelement

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

LabelText

Optionales Control-Element.

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

Text

Optionales LabelText-Element.

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

WebpageControlOptions

Optionales Control-Element.

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

Weitere Informationen finden Sie unter Displaying Web Content within a Work Item Form.

Hinweise

Das Standardverhalten des Link-Elements ist, den Link im Arbeitsaufgabenformular oder der Webseite zu öffnen. Wenn der Link in einem neuen Fenster (target="_blank") geöffnet wird, wird ein externer Browser geöffnet.

Sie können einfachen und durch Links verbundenen Text durch Hinzufügen von mehreren Text-Elementen in einem LabelText-Element kombinieren.

Das LabelText-Element wird nur von Clients erkannt, die die neueste Version von Team Explorer ausführen. Daher muss das Label-Attribut in einem Control-Element angegeben werden, wenn Sie ein untergeordnetes Link-Element angeben. Bei Clients, die die aktuellste Version von Team Explorer ausführen, erscheint der Text, der vom LabelText-Element bereitgestellt wurde, im Arbeitsaufgabenformular. Bei Clients, die frühere Versionen von Team Explorer ausführen, erscheint der Text, der vom Label-Attribut des Control-Elements angegeben wurde, im Arbeitsaufgabenformular.

Beschreibung 

Im folgenden Beispiel wird gezeigt, wie Sie einen Link definieren können, der zum Prozessleitfaden für das Iterationsthema verweist:

https://Servername/sites/Auflistungsname/Projektname/render.aspx?wit=bug&amp;topic=Iteration

Der Name des Projekts wird vom dem "System.Project"-Feld zugewiesenen Wert abgeleitet.

Code

<Link UrlRoot="https://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&amp;topic=Iteration">
   <Param Index="0" Value="System.Project" />
</Link>

Beschreibung 

Im folgenden Beispiel wird veranschaulicht, wie Sie dem Text "work item guidance" einen Link hinzufügen können.

Code

<Control type="LabelControl">
   <LabelText> 
      <Text>
         <Link UrlRoot="https://www.msn.com" />
      work item guidance
      </Text>
   </LabelText> 
</Control>

Beschreibung 

Im folgenden Beispiel wird veranschaulicht, wie Sie einer Feldbezeichnung auf dem Arbeitsaufgabenformular einen Link hinzufügen können.

Code

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="This text comes from the Label attribute:">
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
         This text comes from the inner Label Text
      </Text>
   </LabelText>
</Control>

Schemadefinitionen

  • HyperLinkType

  • NonBlankString

  • HyperLinkParamType

  • HyperLinkParamValueKind

Komplexer Typ: HyperLinkType

<xs:complexType name="HyperLinkType" >
   <xs:sequence>
      <xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
   <xs:attribute name="UrlRoot"  type="NonBlankString" use="required" />
   <xs:attribute name="UrlPath"  type="NonBlankString" use="optional" />
</xs:complexType>

HyperLinkParamType

<xs:complexType name="HyperLinkParamType" >
   <xs:attribute name="Index"     type="PositiveInteger" use="required" />
   <xs:attribute name="Value"     type="xs:string" use="required" />
   <xs:attribute name="Type" type="HyperLinkParamValueKind" use="optional" />
</xs:complexType>

NonBlankString

<xs:simpleType name="NonBlankString">
   <xs:restriction  base="xs:string">
   <xs:pattern value=".*\S+.*"/>
   </xs:restriction>
</xs:simpleType>

HyperLinkParamValueKind

<xs:simpleType name="HyperLinkParamValueKind">
   <xs:restriction base="xs:string">
   <xs:enumeration value="Original"/>
   <xs:enumeration value="Current"/>
   </xs:restriction>
</xs:simpleType>

Elementinformationen

Namespace

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

Schemaname

Definition des Arbeitsaufgabentyps

Validierungsdatei

WorkItemTypeDefinition.xsd

Elementtyp

HyperLinkType, HyperLinkParamType

Kann leer sein

Nicht zutreffend

Siehe auch

Konzepte

Angeben von Steuerelementen für Arbeitsaufgabenformulare

Entwerfen des Arbeitsaufgabenformulars