Referencia de los elementos Link y Param de XML

El elemento Link le permite agregar un hipervínculo a un campo o a una etiqueta independiente en un formulario de elemento de trabajo. Use el elemento Link en las instancias siguientes para:

  • agregar un hipervínculo a una etiqueta de campo;

  • agregar un hipervínculo a una etiqueta independiente o partes de texto informativo;

  • especificar la URL del contenido que se mostrará en un formulario de elemento de trabajo.

Para agregar elementos a un formulario, modifique la definición de un tipo de elemento de trabajo. Vea Modificar o agregar un tipo de elemento de trabajo (WIT) personalizado.

El elemento Link es cualquier elemento secundario del elemento Control o un elemento secundario de los elementos WebpageControlTarget o WebpageControlOptions. Para obtener más información sobre estos elementos, vea Referencia del elemento Control de XML y Referencia de elementos XML WebpageControlOptions.

Jerarquía del esquema

WITD

   WORKITEMTYPE

       FORM

           Diseño

               Agrupar

               Columna

               Tabulador

                     Control

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

Atributos y elementos

En las siguientes secciones se describen los atributos, los elementos secundarios y los elementos primarios.

Atributos y elementos secundarios

Elemento

Atributo

Descripción

Link

 

Elemento Control opcional cuando type="FieldControl".

Elemento LabelText opcional.

Elemento Text opcional.

Elemento WebpageControlOptions opcional.

Elemento contenedor para definir un hipervínculo o una URL. El tipo de elemento es el tipo complejo: HyperLinkType.

 

UrlRoot

El atributo Link es obligatorio.

Especifica el protocolo y el nombre del servidor de la URL a la que está vinculada la etiqueta. Los protocolos compatibles son HTTP, HTTPS y MAILTO.

Puede codificar el nombre del servidor especificado o puede usar una de las siguientes macros y, como opción, anexar la información de dirección adicional a una macro:

Nota

Cada macro se vincula a la dirección URL que está definida y habilitada para el proyecto de equipo del formulario de elemento de trabajo para el que se define el elemento Link.Si alguno de los recursos no se aprovisionan o habilitan para el proyecto de equipo, aparecerá un error de "página no encontrada".

  • @PortalPage: dirección URL del sitio de SharePoint para el proyecto de equipo actual (por ejemplo, http://nombreDeServidor/sites /nombreDeColección/nombreDeProyectoDeEquipo).

  • @ProcessGuidance: dirección URL del sitio de SharePoint para la guía de procesos de un proyecto de equipo.

  • @ReportManagerUrl: dirección URL del servidor que hospeda el Administrador de informes para el proyecto de equipo actual. Esto proporciona un vínculo a la vista de carpetas de los informes (por ejemplo, http://nombreDeServidor/Reports/Pages/Folder.aspx?ItemPath=/nombreDeColección/nombreDeProyectoDeEquipo).

  • @ReportServiceSiteUrl: dirección URL del servidor que hospeda SQL Server Reporting Services para el proyecto de equipo actual más la ruta de acceso base del proyecto de equipo (por ejemplo, http://nombreDeServidor/Reports/Pages/reportservice.asmx?ItemPath = /nombreDeColección/nombreDeProyectoDeEquipo).

Para determinar el valor codificado de las dos primeras macros, puede abrir la configuración de portal de proyecto de un proyecto de equipo. Para más información, vea Configurar o redirigir la guía de procesos.

El tipo de atributo es un tipo simple NonBlankString.

 

UrlPath

Atributo Link opcional.

Especifica la dirección URL del hipervínculo. Use este atributo para especificar parámetros de variables que se determinan en tiempo de ejecución. El tipo de atributo es un tipo simple NonBlankString.

Param

 

Elemento Link opcional. Obligatorio cuando se especifica UrlPath.

Especifica un valor que se usará para determinar la dirección URL del hipervínculo cuando se especifique UrlPath.

El tipo de elemento es el tipo complejo: HyperLinkParamType.

 

Index

El atributo Param es obligatorio.

Especifica el índice del parámetro donde debe darse formato al valor en la cadena de dirección URL. No es necesario ordenar los valores de índice secuencialmente; sin embargo, deben coincidir con el número de índice de la cadena URLPath.

El tipo de atributo es PositiveInteger. El primer número de índice debe ser 0.

 

Value

El atributo Param es obligatorio.

Especifica el número asociado con el valor de una dirección URL del hipervínculo.

Especifica un valor al que debe darse formato en la cadena URLPath. Los valores deben ser nombres de referencia válidos de campos usados en la definición de tipo de elemento de trabajo.

Se admite la variable @Me. Se reemplaza por el nombre del miembro del equipo actual que está viendo el formulario de elemento de trabajo. Los valores no distinguen mayúsculas de minúsculas.

El tipo de atributo es xs:string.

 

Type

Atributo Param opcional.

Especifica que debe usarse el valor original del campo para el parámetro. El tipo de atributo es un tipo simple: HyperLinkParamValueKind.

Los valores válidos son los siguientes:

  • Original: especifica que se use el valor del parámetro original para determinar la dirección URL.

  • Current: especifica que se use el valor del parámetro actual para determinar la dirección URL.

Si no se especifica este atributo, se usa como parámetro el valor actual del campo.

Elementos primarios

Elemento

Descripción

Control

Requerido. Define un campo, texto, hipervínculo u otro elemento de control que aparecerá en el formulario de elemento de trabajo.

LabelText

Elemento Control opcional.

Elemento contenedor para una etiqueta que aparecerá en el formulario de elemento de trabajo.

Texto

Elemento LabelText opcional.

Elemento contenedor para la información o etiqueta que aparecerá en el formulario de elemento de trabajo.

WebpageControlOptions

Elemento Control opcional.

Elemento contenedor que especifica las opciones para el control de página web.

Para obtener más información, vea el tema sobre visualización de contenido web en un formulario de elemento de trabajo.

Comentarios

El comportamiento predeterminado del elemento Link es abrir el hipervínculo en la página web o en un formulario de elemento de trabajo. Si el hipervínculo se crea para que se abra en una nueva ventana (target = "_blank"), entonces se abre un explorador externo.

Puede combinar texto sin formato y con hipervínculo si agrega varios elementos Text en un elemento LabelText.

El elemento LabelText solo es reconocido por los clientes que ejecutan la versión más reciente de Team Explorer. Por tanto, si especifica un elemento Label secundario, debe especificar también el atributo Control en un elemento Link. Para los clientes que ejecutan la versión más reciente de Team Explorer, el texto proporcionado por un elemento LabelText aparece en el formulario de elemento de trabajo. Para los clientes que ejecutan versiones anteriores de Team Explorer, el texto especificado por el atributo Control del elemento Label aparece en el formulario de elemento de trabajo.

Ejemplo: Especificar un hipervínculo con parámetros

Descripción

En el ejemplo siguiente se muestra cómo definir un hipervínculo que enlace a la guía de procesos del tema de iteración:

http://nombreServidor/sitios/nombreColección/nombreProyecto/render.aspx?wit=bug&amp;topic=Iteration

El nombre del proyecto se deriva del valor asignado al campo System.Project.

Código

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

Ejemplo: Agregar un hipervínculo a una etiqueta independiente

Descripción

En el ejemplo siguiente se muestra cómo se puede asignar un hipervínculo para el texto "work item guidance" en un formulario de elemento de trabajo.

Código

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

Ejemplo: Agregar un hipervínculo a un campo

Descripción

En el ejemplo siguiente se muestra cómo se puede agregar un hipervínculo a la etiqueta de un campo en un formulario de elemento de trabajo.

Código

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

Definiciones de esquema

  • HyperLinkType

  • NonBlankString

  • HyperLinkParamType

  • HyperLinkParamValueKind

Tipo complejo: 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>   

Información de elemento

Espacio de nombres

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

Nombre de esquema

Definición del tipo de elemento de trabajo

Archivo de validación

WorkItemTypeDefinition.xsd

Tipo de elemento

HyperLinkType, HyperLinkParamType

Puede estar vacío

No aplicable

Vea también

Conceptos

Especificar controles de formulario de elemento de trabajo

Diseñar el formulario de elemento de trabajo