Compartilhar via


Referência de elementos XML para link e parâmetro

Você pode adicionar um hiperlink a um campo ou um rótulo autônomo em um formulário de item de trabalho usando o Link elemento. Você usa o Link elemento nas seguintes instâncias para:

  • Adicionar um hiperlink a um rótulo de campo

  • Adicionar um hiperlink a um rótulo autônomo ou partes de texto informativo

  • Especifique a URL para o conteúdo a ser exibido em um formulário de item de trabalho

Para adicionar elementos a um formulário, você deve modificar a definição de um tipo de item de trabalho. Consulte Modificar ou adicionar um WIT (tipo de item de trabalho) personalizado.

O Link elemento é um elemento filho do Control elemento ou um elemento filho a WebpageControlTarget ou WebpageControlOptions elementos. Para obter mais informações sobre esses elementos, consulte Referência do elemento XML de controle e Referência de elementos XML WebpageControlOptions.

Hierarquia de esquema

WITD

   WORKITEMTYPE

       FORMULÁRIO

           Layout

               Group

               Coluna

               Tabulação

                     Controle

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

Atributos e elementos

As seções a seguir descrevem atributos, elementos filho e elementos pai.

Atributos e elementos filho

Elemento

Atributo

Descrição

Link

 

Opcional Control elemento quando type="FieldControl".

Opcional LabelText elemento.

Opcional Text elemento.

Opcional WebpageControlOptions elemento.

Elemento de contêiner para definir um hiperlink ou uma URL. O tipo de elemento é o tipo complexo: HyperLinkType.

 

UrlRoot

Atributo Link obrigatório.

Especifica o protocolo e o nome do servidor da URL para que os links de rótulo. Protocolos suportados são HTTP, HTTPS e MAILTO.

Você pode qualquer codificar o nome do servidor especificado ou você pode usar um dos seguintes macros e opcionalmente anexar informações adicionais de endereço para uma macro:

Dica

Cada links de macro para a URL que é definida e habilitada para o projeto de equipe do formulário de item de trabalho para o qual o Link elemento é definido.Se qualquer um dos recursos não são provisionadas ou habilitada para o projeto de equipe, um erro "página não encontrada" será exibida.

  • @PortalPage: A URL do site do SharePoint para o team project atual (por exemplo, https://serverName/sites/NomedaColeção/Nomedoprojetodaequipe).

  • @ProcessGuidance: A URL do site do SharePoint para orientação do processo para um projeto de equipe.

  • @ReportManagerUrl: A URL do servidor que hospeda o Gerenciador de relatórios para o team project atual. Isso fornece um link para o modo de exibição de pasta para os relatórios (por exemplo, https://serverName/Reports/Pages/Folder.aspx?ItemPath=/NomedaColeção/Nomedoprojetodaequipe).

  • @ReportServiceSiteUrl: A URL do servidor que hospeda SQL Server Reporting Services atual team project e o caminho base para o projeto de equipe (por exemplo, https://serverName/Reports/Pages/reportservice.asmx?ItemPath = /NomedaColeção/Nomedoprojetodaequipe).

Para determinar o valor codificado para as duas primeiras macros, você pode abrir as configurações do portal de projeto para um projeto de equipe. Para obter mais informações, consulte Configurar ou redirecionar diretrizes de processo.

O tipo de atributo é simples: NonBlankString.

 

UrlPath

Atributo Link opcional.

Especifica um caminho de URL do hiperlink. Use esse atributo para especificar parâmetros variáveis que são determinados em tempo de execução. O tipo de atributo é simples: NonBlankString.

Param

 

Opcional Link elemento. Necessário quando UrlPath for especificado.

Especifica um valor a ser usado para determinar a URL do hiperlink quando UrlPath for especificado.

O tipo de elemento é o tipo complexo: HyperLinkParamType.

 

Index

Atributo Param obrigatório.

Especifica o índice do parâmetro em que o valor deve ser formatado na cadeia de caracteres de URL. Não é necessário para solicitar valores de índice seqüencialmente; No entanto, eles deverão coincidir com o número do índice de URLPath cadeia de caracteres.

O tipo de atributo é PositiveInteger. O primeiro número de índice deve ser 0.

 

Value

Atributo Param obrigatório.

Especifica o número associado ao valor de um caminho de URL do hiperlink.

Especifica um valor que deve ser formatado para o URLPath cadeia de caracteres. Valores devem ser nomes válidos de referência dos campos usados na definição de tipo de item de trabalho.

O @Me variável é suportado. Ele será substituído com o nome do membro da equipe atual que está exibindo o formulário de item de trabalho. Valores não diferenciam maiúsculas de minúsculas

O tipo de atributo é xs:string.

 

Type

Atributo Param opcional.

Especifica que o valor original do campo deve ser usado para o parâmetro. O tipo de atributo é simples:HyperLinkParamValueKind.

Os valores válidos são os seguintes:

  • Original: Especifica para usar o valor do parâmetro original para determinar o caminho da URL.

  • Current: Especifica para usar o valor do parâmetro atual para determinar o caminho da URL.

Se esse atributo não for especificado, o valor atual do campo é usado como um parâmetro

Elementos pai

Elemento

Descrição

Controle

Obrigatório. Define um campo, texto, hiperlinks ou outro elemento de controle apareça no formulário de item de trabalho.

LabelText

Opcional Control elemento.

Elemento de contêiner para um rótulo apareça no formulário de item de trabalho.

Texto

Opcional LabelText elemento.

Elemento de contêiner para as informações ou o rótulo a ser exibido no formulário de item de trabalho.

WebpageControlOptions

Opcional Control elemento.

Elemento de contêiner que especifica as opções para o controle de página da Web.

Para obter mais informações, consulte Displaying Web Content within a Work Item Form.

Comentários

O comportamento padrão do Link elemento é abrir o hiperlink na página da Web ou formulário de item de trabalho. Se o hiperlink é criado para abrir em uma nova janela (destino = blank"), e um navegador externo é aberto.

Você pode combinar texto sem formatação e hiperlink adicionando vários Textelementos em uma LabelText elemento.

O LabelText elemento só é reconhecido por clientes que estão executando a versão mais recente do Team Explorer. Portanto, você deve especificar o Label atributo em uma Control quando você especifica um filho de elemento Link elemento. Para clientes que estejam executando a versão mais recente do Team Explorer, o texto fornecido pela um LabelText elemento aparece no formulário de item de trabalho. Para clientes que estejam executando versões anteriores do Team Explorer, o texto especificado o Control elemento Label atributo aparece no formulário de item de trabalho.

Descrição

O exemplo a seguir mostra como você pode definir um hiperlink que vincula a orientação do processo para o tópico de iteração:

https://serverName/sites/collectionName/projectName/render.aspx?wit=bug & amp; tópico = iteração

O nome do projeto é derivado do valor atribuído ao 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>

Descrição

O exemplo a seguir mostra como você pode atribuir um hiperlink ao texto "trabalho item guia" em um formulário de item de trabalho.

Código

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

Descrição

O exemplo a seguir mostra como você pode adicionar um hiperlink para o rótulo de um campo em um formulário de item de trabalho.

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>

Definições de esquema

  • HyperLinkType

  • NonBlankString

  • HyperLinkParamType

  • HyperLinkParamValueKind

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

Informações do elemento

Namespace

https://schemas.microsoft.com/VisualStudio/2008/WorkItemTracking/TypeDef

Nome do esquema

Definição de tipo de Item de trabalho

Arquivo de validação

WorkItemTypeDefinition.xsd

Tipo de elemento

HyperLinkType, HyperLinkParamType

Pode estar vazio

Não aplicável

Consulte também

Conceitos

Especificar controles de formulários de itens de trabalho

Criar o formulário de item de trabalho