Compartilhar via

Todas as referências de elementos do formulário XML

  • Artigo

Você pode usar as informações neste tópico, como uma referência rápida para todos os elementos e atributos principais que controlam o formulário para um tipo de item de trabalho. Esses elementos em você especifica o FORM contêiner do elemento, a terceira e última seção principal da definição de um tipo de item de trabalho. Muitos elementos são aninhados dentro de outras pessoas para formar grupos, seções ou guias em um formulário de item de trabalho. Para obter mais informações sobre como agrupar esses elementos, consulte Criar o Layout do formulário de Item de trabalho.

Neste tópico

  • FORM Example

  • Sintaxe dos elementos de formulário

  • Atributos que especificam a elementos de formulário

  • Elementos que especificam os rótulos autônomos, hiperlinks, páginas da Web ou conteúdo HTML

  • Elementos que filtrar e exibem relacionamentos de Link

FORM Example

O exemplo a seguir mostra a estrutura geral do FORM elemento. Você especifica o layout de um formulário usando o Layout elemento. Você pode especificar diferentes layouts diferentes clientes de destino. Por exemplo, você pode especificar um layout para clientes Windows e um layout diferente para Team Web Access. Um layout geralmente consiste na parte superior do formulário e, em seguida, um grupo de guias. A seqüência na qual você define os elementos no layout determina a seqüência na qual os elementos aparecem no formulário.

Agrupar elementos apareçam nas colunas usando o Group e Column elementos. Você pode usar um Control elemento para definir cada campo que você deseja que apareça no formulário. Você pode usar o Tab elemento para oferecer suporte a diferentes áreas funcionais de grupos de campo.

<FORM>
      <Layout>
        <Group>
          <Column PercentWidth="70">
            <Group>
              <Column PercentWidth="100">
                <Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />
                <Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />
                <Control FieldName="System.IterationPath" Type="WorkItemClassificationControl" Label="&amp;Iteration Path:" LabelPosition="Left" />
                <Group>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.ProductUnit" Type="FieldControl" Label="PU (Use Area Path)" LabelPosition="Left" />
                  </Column>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.Priority" Type="FieldControl" Label="Priority" LabelPosition="Left" />
                  </Column>
                </Group>
              </Column>
            </Group>
          </Column>
          <Column PercentWidth="30">
            <Group Label="Status">
              <Column PercentWidth="100">
                <Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />
                <Control FieldName="System.State" Type="FieldControl" Label="State" LabelPosition="Left" />
                <Control FieldName="System.AssignedTo" Type="FieldControl" Label="Assigned To" LabelPosition="Left" />
              </Column>
            </Group>
          </Column>
        </Group>

. . .
</Layout>
</FORM>

Elementos de formulário

Você pode especificar como os campos de item de trabalho e as informações são agrupados e aparecem em um formulário de item de trabalho usando os elementos que estão descritos na tabela a seguir.

ObservaçãoObservação

Para obter melhores resultados, você deve se aninhar Control elementos em um Group, e você deve se aninhar Group elementos em um Column, mesmo se a coluna atinge a largura total do formulário. Além disso, você deve se aninhar cada Column seção em um Group, mesmo se o grupo não tem rótulo visível ou limite.

Elemento

Descrição

Necessário?

Column

Divide as regiões de um formulário em colunas.

<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Column >

Recomendável

Control

Define um campo, o texto, o hiperlink ou outro elemento de controle seja exibido no formulário de item de trabalho.

<Control FieldName="FieldName" Type="AttachmentsControl | DateTimeControl | FieldControl | 
HtmlFieldControl | LabelControl | LinksControl | WebpageControl | WorkItemClassificationControl | 
WorkItemLogControl" Label="LabelText" LabelPosition="Top | Bottom | Left | Right" 
Dock="Fill | Top | Bottom | Left | Right" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" ReadOnly="True | False" MinimumSize="(Width,Height)" 
Name="InstanceName" />

Para obter mais informações, consulte Referência de elemento do controle XML.

Necessário

FORM

Define o elemento de nível superior do formulário.

<FORM>
   <Layout> . . . </Layout>
</FORM>

Necessário

Group

Fornece um agrupamento visual de elementos, semelhantes à caixa de grupo do Windows.

<Group Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)">
   <Column> . . . </Column>
</Group >

Recomendável

Layout

Define o layout do formulário de item de trabalho.

<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance">
   <Group> . . . </Group>
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</LAYOUT>

Necessário

Splitter

Divide a um formulário em duas áreas para suportar o layout de dois elementos de formulário do irmão.

Splitter Dock="Left" />

Optional

Tab

Define o layout de uma única guia em um grupo de guias.

<TAB Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</TAB>

Optional

TabGroup

Define uma ou mais guias para o formulário.

<TabGroup Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)">
   <Tab> . . . </Tab>
</TabGroup>

Optional

Voltar ao topo

Atributos que são usados para formatar elementos de formulário

Você pode controlar o espaçamento e o tamanho dos muitos elementos em um formulário de item de trabalho, especificando os atributos que a tabela a seguir descreve. Para obter mais informações, consulte Criar o Layout do formulário de Item de trabalho.

Atributo

Descrição

Elementos aplicáveis

ControlSpacing

Opcional. Especifica o deslocamento vertical de controles. Número inteiro.

Layout

Dock

Opcional. Alonga um controle de campo ou um divisor para preencher o restante do recipiente. Valores de campo válido de encaixe são: Preenchimento, Top, Bottom, Left, e direita.

  • Fill: Alinha o campo para que ela preencha o recipiente.

  • Top: Alinha o campo com a parte superior do recipiente.

  • Bottom: Alinha o campo com a parte inferior do recipiente.

  • Left: Alinha o campo ou o divisor com o lado esquerdo do recipiente. Esse valor é a orientação com suporte apenas para o SPLITTER elemento.

  • Right: Alinha o campo ou o divisor do lado direito do recipiente.

Control

Splitter

FixedWidth

Opcional. A largura da coluna em pixels. PercentWidthe FixedWidth são mutuamente exclusivas.

Column

Label

Opcional. Texto a ser exibido para um controle ou o grupo. Se um rótulo for especificado, ele substitui qualquer rótulo associado com o campo de metadados para o controle.

Necessário para o TAB elemento. Texto a ser exibido para uma guia.

LabelText é uma seqüência de texto que contenha entre 1 e 80 caracteres.

Control

Group

Tab

LabelPosition

Opcional. A posição do rótulo em relação aos dados do campo. Valores possíveis são: superior, inferior, esquerda e direita.

Control

LabelSpacing

Opcional. Especifica o número de pixels entre o rótulo e a região de edição do controle.

Layout

Margin

Opcional. Seqüência de caracteres do formulário (esquerda, superior, direita, inferior) que especifica, em pixels, a quantidade de espaço ao redor do controle e entre o controle e seus vizinhos. Você pode variar a quantidade de espaço em cada lado.

Valor padrão: ^\(\d+\,\d+\,\d+\,\d+\)$

Exemplo de valor padrão: (2,0,2,0)

Control

Group

Layout

Tab

TabGroup

MinimumSize

Opcional. A seqüência de caracteres do formulário (largura, altura). Esse valor Especifica o tamanho mínimo para o próprio formulário. Quando o contêiner de controle de menores do que esse tamanho, aparecem as barras de rolagem horizontais e verticais.

Control

Layout

Name

Opcional. Nome do controle. Se não for especificado, o nome é igual a FieldName.

Control

Padding

Opcional. A seqüência de caracteres do formulário (esquerda, superior, direita, inferior) que especifica, em pixels, a quantidade de espaço ao redor da borda externa do controle e ao redor do interior borda. Você pode variar a quantidade de espaço em cada lado.

Control

Group

Layout

Tab

TabGroup

PercentWidth

Opcional. A largura da coluna como uma porcentagem da largura do recipiente do elemento. PercentWidthe FixedWidth são mutuamente exclusivas.

Column

ReadOnly

Opcional. Você pode exibir um campo somente leitura em um controle. Controles diferentes são responder a este atributo maneiras ligeiramente diferentes.

Control

Target

Opcional. Seqüência de caracteres que especifica para qual cliente se aplica a esse layout. Visual StudioExibe o tipo de item de trabalho neste layout se o Target atributo for omitido ou for definido como Windows Forms. Os clientes externos podem especificar outros layouts usando personalizado Target atributos que Visual Studio ignora.

Os seguintes valores são válidos:

  • WinForms: Aplica-se o formulário para Team Explorer e Team Explorer Everywhere.

  • Web: Aplica-se o formulário para Team Web Access.

Layout

Type

Obrigatório. O tipo de controle. Para obter mais informações, consulte Referência de elemento do controle XML.

Control

Voltar ao topo

O WebpageControlOptions elemento e seus elementos filho tem a seguinte estrutura de sintaxe:

<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
   <Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
      <Param index="IndexValue" value="ParamValue" type ="Original | Current"/>
   </Link>
   <Content>
      <![CDATA[Contents of HTML]]>
   </Content>
</WebpageControlOptions>

Você usar os elementos que estão descritos na tabela a seguir para definir o texto sem formatação ou rótulos de hiperlink, adicionar hiperlinks a um campo ou exibir o conteúdo da página da Web em um formulário de item de trabalho. Para obter mais informações, consulte Fornecendo o texto de Ajuda, orientação do processo, conteúdo da Web e Links para páginas da Web em um formulário de Item de trabalho.

Elemento

Necessário?

Descrição

Content

Opcional WebpageControlOptions elemento.

Especifica o conteúdo baseado em HTML de CDATA apareça em um formulário de item de trabalho.

<Content>
   <![CDATA[Contents of HTML]]>
</Content>

Para obter mais informações, consulte Referência de elementos XML de WebpageControlOptions.

LabelText

Opcional Control elemento ao type="LabelControl".

Define ou uma etiqueta simples ou hiperlink.

Para obter mais informações, consulte Referência de elementos XML LabelText e texto.

Link

Opcional Control elemento ao type="FieldControl".

Opcional Text elemento.

Opcional WebpageControl elemento.

Opcional WebpageControlOptions elemento.

Define o hiperlink para um campo, o rótulo ou o conteúdo do navegador da Web em um formulário de item de trabalho.

<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param />
</Link>

Para obter mais informações, consulte Link e referência de elementos XML de Param.

Param

Opcional Link elemento.

Especifica um valor para determinar a URL do hiperlink quando URLPath é especificado para o Link elemento.

<Param index="IndexValue " value="ParamValue " type ="Original | Current"/>

Para obter mais informações, consulte Link e referência de elementos XML de Param.

Text

Opcional LabelText elemento.

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

<Text>
   <Link >
      <Param />
   </Link>
   LabelText
</Text>

Para obter mais informações, consulte Referência de elementos XML LabelText e texto.

WebpageControlOptions

Opcional Control elemento ao type="WebpageControl"

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

Para obter mais informações, consulte Referência de elementos XML de WebpageControlOptions.

Voltar ao topo

Você pode usar o LinksControlOptions elemento para definir as opções para controlar quais links pode ser adicionado a um item de trabalho e as colunas padrão que você deseja que apareça para a lista de links em um item de trabalho. Quando você adiciona um controle de link para um formulário de item de trabalho, você pode especificar filtros restringem os tipos de links que os usuários podem criar e os tipos de itens de trabalho entre os quais usuários podem criar vínculos. O LinksControlOptions elemento e seus elementos filho tem a seguinte estrutura:

<LinksControlOptions>
   <WorkItemLinkFilters FilterType="include | exclude | includeAll | excludeAll">
       <Filter LinkType="linkTypeRefName" FilterOn="reverseName | forwardName" />
   </WorkItemLinkFilters>
   <ExternalLinkFilters FilterType ="include | exclude | includeAll | excludeAll">
       <Filter LinkType="externalLinkName"/>
   </ExternalLinkFilters>
   <WorkItemTypeFilters Scope=" project | all" FilterType=" include | exclude | includeAll" />
       <Filter WorkItemType="workItemTypeReferenceName"/>
   </WorkItemTypeFilters>
   <LinkColumns>
      <LinkColumn RefName="referenceName" | LinkAttribute="linkAttributeName"/>
   </LinkColumns>
</LinksControlOptions>

Especificamente, você pode usar os elementos que estão resumidos na tabela a seguir. Para obter mais informações sobre como usar esses elementos, consulte Definir controles de Link para restringir os relacionamentos de Link e Elementos de LinksControlOptions.

Elemento

Necessário?

Descrição

LinksControlOptions

Opcional Control elemento ao type="LinksControl"

Fornece um contêiner para elementos que definem as opções para controlar quais links pode ser adicionado a um item de trabalho e as colunas padrão que você deseja exibir a lista de links em um item de trabalho.

WorkItemLinkFilters

Opcional LinksControlOptions elemento

Fornece um contêiner para um ou mais Filter elementos que especificam os critérios de filtro de link para os tipos de link que são definidos para a coleção de projeto de equipe.

ExternalLinkFilters

Opcional LinksControlOptions elemento

Fornece um contêiner para um ou mais Filter elementos que especificam os critérios de filtro a ser usado para tipos de link que são definidos em outros projetos de equipe.

WorkItemTypeFilters

Opcional LinksControlOptions elemento

Fornece um contêiner para um ou mais Filter elementos que especificam os critérios de filtro para aplicar a funcionar em tipos de item.

Filter(tipos de link)

Obrigatório WorkItemLinkFilters elemento quando o FilterType atributo é exclude ou include.

Obrigatório ExternalLinkFilters elemento quando o FilterType atributo é exclude ou include.

Especifica os tipos de links para incluir ou excluir do conjunto de links que podem ser criados para o item de trabalho.

Filter(tipos de item de trabalho)

Opcional WorkItemTypeFilters elemento quando o FilterType atributo é exclude ou include.

Especifica os tipos de itens de trabalho para incluir ou excluir do conjunto de tipos de item de trabalho entre os quais os usuários podem vincular.

LinkColumns

Opcional LinksControlOptions elemento

Fornece um contêiner para um ou mais LinkColumn marcas.

LinkColumn

Obrigatório LinkColumns elemento

Especifica os campos de item de trabalho e os atributos de tipo de link apareça em que o formulário de item de trabalho para a lista de links.

Voltar ao topo

Consulte também

Conceitos

Criar o Layout do formulário de Item de trabalho

Criando e personalizando um formulário de Item de trabalho

Outros recursos

Índice de definições de elemento XML para tipos de itens de trabalho

Histórico de alterações

Date

History

Motivo

Janeiro de 2011

Adicionado o exemplo e a sintaxe para todas as FORM elementos. Removidos os links para tópicos que foram removidos.

Aprimoramento de informações.

Julho de 2010

Adicionados links para tópicos que foram adicionados a atualização anterior.

Aprimoramento de informações.