Proporcionar texto de ayuda, guía de procesos, contenido web y vínculos con páginas web en un formulario de elemento de trabajo

Al personalizar el formulario de elemento de trabajo, quizás desee proporcionar información o vínculos al contenido que ayuden a su equipo a definir los campos en el formulario. Si agrega información al formulario, bien incrustándola o haciendo que esté fácilmente disponible, los miembros del equipo podrán realizar un mejor seguimiento de los datos útiles.

Mediante los controles de formulario que se describen en este tema, puede agregar texto de información sobre herramientas para campos individuales, texto independiente, o hipervínculos a páginas web, o bien puede incrustar contenido HTML o contenido web en el formulario.

En este tema

• Proporcionar texto de ayuda o texto de información sobre herramientas

• Agregar texto independiente y etiquetas de campo con hipervínculos

• Mostrar contenido web

• Incrustar la Guía de procesos

Proporcionar texto de ayuda o texto de información sobre herramientas

Puede proporcionar texto de Ayuda de dos maneras. En el primer método, deberá agregar el elemento HELPTEXT como elemento secundario del elemento FIELD en la sección FIELDS de la definición de tipos. Mediante HELPTEXT, crea la información sobre herramientas para el campo. Con este método, existe un límite de 255 caracteres.

<FIELD name="Sub-Title" refname="ACME.ACE.ImpactStatement" type="HTML" >
<HELPTEXT>Provide information about the impact to the ACE organization. </HELPTEXT>
</FIELD>

Con el segundo método, especifica el texto independiente utilizando los elementos secundarios Text y LabelText. Con este método, puede agregar tanta información como desee y el texto siempre está presente en el formulario. No es necesaria ninguna acción por parte del usuario. También puede agregar un vínculo opcional a más información mediante el elemento Link, como se muestra en el siguiente ejemplo.

<Control FieldName=" ACME.ACE.ImpactStatement" Type="HTMLControl" Label="Impact" LabelPosition="Left"> 
   <LabelText>
      <Text> Provide information about the impact to the ACE organization. Specifically address the following: customer segment, target strategic opportunity, resources required, and time dependencies. For more detailed information, see the Impact Statement specification at:
         <Link OpenInNewWindow="true" UrlRoot=http://ACE.ImpactStatement.aspx />
      </Text>
   </LabelText>
</Control>

Agregar texto independiente y etiquetas de campo con hipervínculos

Puede agregar texto a un formulario de elemento de trabajo que no está asociado a ningún campo de elemento de trabajo utilizando la opción LabelControl del atributo Type del elemento Control. El texto puede ser sin formato o proporcionar un hipervínculo. Asimismo, puede adjuntar un hipervínculo a una etiqueta de campo agregada mediante la opción FieldControl.

Ejemplo: Etiqueta de texto sin formato

En el siguiente ejemplo se agrega el texto sin formato "Fill in the details of the bug here. Fields that are not required are recommended to be filled in." al campo de elemento de trabajo.

<Control Type="LabelControl" Label="Fill in the details of the bug here. Fields that are not required are recommended to be filled in." />

Ejemplo: Etiqueta de campo con hipervínculo

En el siguiente ejemplo se muestra cómo agregar un hipervínculo a una etiqueta de campo.

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="Title 1"
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
            Title 2
      </Text>
   </LabelText>
</Control>

Nota

Para los clientes de Team Foundation que no hayan actualizado a la última versión, aparece el texto del atributo Label. Para los clientes de Visual Studio 2010, la etiqueta Text se muestra como un hipervínculo en el cual la dirección URL está definida por la etiqueta Link.

Ejemplo: Etiqueta de campo con hipervínculo para la parte del texto

En el siguiente ejemplo se muestra cómo agregar un hipervínculo a parte de una etiqueta de campo. En el ejemplo, la dirección URL viene determinada por los valores asignados a los elementos Param según el elemento de trabajo en cuestión.

<Control Type="FieldControl" FieldName="System.IterationPath">
   <LabelText LabelPosition="Left">
      <Text>
         <Link UrlPath="http://{0}/sites/{1}/render.aspx?wit=bug&amp;topic=Iteration">
            <Param value="@Server"/>
            <Param value="System.Project"/>
         </Link>
            Iteration Path
      </Text>
      <Text> (must be 3 levels deep)</Text>
   </LabelText>
</Control>

Ejemplo: Etiqueta de texto con hipervínculo

Etiqueta de texto con hipervínculo

En el siguiente ejemplo se muestra cómo agregar un hipervínculo al texto mostrado en un formulario de elemento de trabajo.

<Group>
   <Column PercentWidth="100">
      <!-- Standalone label control 2 -->
      <Control Type="LabelControl" Label="How do I use this work item?">
         <Link UrlRoot="http://www.live.com"></Link>
      </Control>
   </Column>
</Group>

Ejemplo: Combinar texto e hipervínculos en una etiqueta única

Combinar texto e hipervínculos en una etiqueta única

En el siguiente ejemplo se muestra cómo agregar dos hipervínculos a las partes de una etiqueta en un formulario de elemento de trabajo.

<Group>
   <Column PercentWidth="100">
   <!-- Standalone label control 3 -->
      <Control Type="LabelControl" Name="Microsoft.VSTS.Common.GuidanceLabel3">
         <LabelText>
            <Text>Click here for </Text>
            <Text>
               <Link UrlRoot="https://www.msn.com"></Link>
               work item guidance</Text>
            <Text> or here for </Text>
            <Text>
               <Link UrlRoot="http://www.msdn.com"></Link>
               process guidance
            </Text>
         </LabelText>
      </Control>
   </Column>
</Group>

Ejemplo: Etiqueta de campo de hipervínculo generada por parámetros

En el siguiente ejemplo se muestra cómo agregar un hipervínculo a una etiqueta de campo que se genera a partir de los valores de parámetro que se evalúan para el elemento de trabajo abierto.

<Control Type="FieldControl" FieldName="System.State" Label="&amp;State:" LabelPosition="Left">
   <Link OpenInNewWindow="true" URLRoot="http://{0}/sites/{1}/render.aspx?wit=bug&amp;state={2}">
      <Param value="@Server"/>
      <Param value="System.Project"/>
      <Param value="System.State" type ="original"/>
   </Link>
</Control>

Mostrar contenido web

Puede utilizar la opción WebpageControl del atributo Type para mostrar el contenido web en el formulario de elemento de trabajo como un control en lugar de crear un vínculo a una página web independiente. Esta presentación puede ser útil para proporcionar métricas que ayuden a los miembros del equipo a ver el contenido de un informe, panel u otro contenido basado en HTML. Puede proporcionar un vínculo al contenido o incrustar el contenido HTML sin formato en una etiqueta de CDATA.

Ejemplo: Mostrar contenido proporcionado por un URI

En el siguiente ejemplo se muestra cómo se puede incrustar el contenido de una página web si se proporciona la dirección URL de la página mediante los elementos WebpageControlOptions y LINK.

<Tab Label="Web">
   <Group>
      <Column PercentWidth="100">
         <Control Type="WebpageControl" Name="WssPortalPage" Label="WssPortalPage" LabelPosition="Top" Dock="Fill">
            < WebpageControlOptions AllowScript="false">
               <Link UrlRoot="http://www.msdn.com" />
            </WebpageControlOptions >
         </Control>
      </Column>
   </Group>
</Tab>

Ejemplo: Mostrar contenido proporcionado en una etiqueta de CDATA

En el siguiente ejemplo se muestra cómo se puede agregar el contenido HTML a un formulario de elemento de trabajo incluido en una etiqueta CDATA.

<Control Type="WebpageControl">
   <WebpageControlOptions>
      <Content>
      <![CDATA[Place HTML Formatted Content Here ]]
   </Content>
   </WebpageControlOptions >
</CONTROL>

Incrustar la Guía de procesos

Para que la guía de procesos esté disponible en el formulario de elemento de trabajo, quizás desee agregar una pestaña que contenga información sobre el flujo de trabajo y el uso del tipo de elemento de trabajo. Puede hacerlo mediante la opción WebpageControl del atributo Type. Esta opción proporciona compatibilidad para incrustar texto con formato enriquecido e imágenes en el formulario mediante los elementos secundarios WebpageControlOptions y Content.

<FORM>
. . .
<TabGroup>
. . . 
   <Tab Label="Process Guidance">
      <Group>
         <Column PercentWidth="100">
            <Control Type="WebpageControl">
            <WebpageControlOptions >
            <Content>
               <![CDATA[Place HTML Formatted Process Guidance Content Here ]]>
            </Content>
            </WebpageControlOptions>
            </Control>
         </Column>
      </Group>
   </Tab>
. . .
</TabGroup>
. . .
</FORM>

Vea también

Referencia

Referencia de elementos Control de XML

FIELD (Workflow) (elemento)

Conceptos

Especificar controles de formulario de elemento de trabajo

Diseñar el diseño de formularios de elemento de trabajo

Personalizar datos de seguimiento, formularios, flujos de trabajo y otros objetos de proyecto

Otros recursos

Controlar cómo se muestran los campos de los elementos de trabajo

Historial de cambios

Fecha	Historial	Motivo
Mayo de 2011	Se ha corregido el uso de minúsculas o mayúsculas en varios elementos y atributos de la sintaxis XML. La definición de esquema para el seguimiento de elementos de trabajo establece todos los elementos secundarios del elemento FORM con la convención Camel y escribe los demás elementos en mayúsculas.	Corrección de errores de contenido.