Todas as referências de elementos XML FORM

Artigo
06/09/2015

Você pode usar as informações deste tópico como uma referência rápida para todos os elementos e atributos principais que controlam a forma de um tipo de item de trabalho. Você especifica esses elementos no 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 em outras guias em um formulário de item de trabalho, seções ou grupos do formulário. Para obter mais informações sobre como agrupar esses elementos, consulte Criar o formulário de item de trabalho.

Neste tópico

Exemplo de formulário
Sintaxe dos elementos de formulário
Atributos que especificam os 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 as relações de link

Exemplo de formulário

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

Agrupar elementos para aparecer em colunas usando o Group e Column elementos. Você usa um Control elemento para definir cada campo que você deseja exibir no formulário. Você usa o Tab elemento para dar suporte a diferentes áreas funcionais de grupos de campos.

<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 de informações são agrupados e aparecem em um formulário de item de trabalho usando os elementos descritos na tabela a seguir.

Dica

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

Elemento	Descrição	Obrigatório?
Column	Divide regiões do formulário em colunas. `<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels"> <Group> . . . </Group <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Column >`	Recomendável
Control	Define um campo, texto, hiperlinks ou outro elemento de controle apareça 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" Padding="(top, bottom, left, right)" Margin="( top, bottom, left, right)" ReadOnly="True \| False" MinimumSize="(Width,Height)" Name="InstanceName" />` Para obter mais informações, consulte Referência do elemento XML de controle.	Obrigatório
FORM	Define o elemento de nível superior do formulário. `<FORM> <Layout> . . . </Layout> </FORM>`	Obrigatório
Group	Fornece um agrupamento visual dos elementos, como a caixa de grupo do Windows. `<Group Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)"> <Column> . . . </Column> </Group >`	Recomendável
Layout	Define o layout do formulário de item de trabalho. `<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(top, bottom, left, right)" Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance"> <Group> . . . </Group> <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Layout>`	Obrigatório
Splitter	Divide um formulário em duas áreas para dar suporte a layout de dois elementos irmãos de formulário. `Splitter />`	Opcional
Tab	Define o layout de uma única guia em um grupo de guias. `<Tab Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)"> <Group> . . . </Group <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Tab>`	Opcional
TabGroup	Define uma ou mais guias para o formulário. `<TabGroup Padding="( top, bottom, left, right)" Margin="(top, bottom, left, right)"> <Tab> . . . </Tab> </TabGroup>`	Opcional

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

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

Atributo	Descrição	Elementos aplicáveis
ControlSpacing	Opcional. Especifica o deslocamento vertical de controles. Inteiro.	Layout
FixedWidth	Opcional. A largura da coluna em pixels. PercentWidthe FixedWidth são mutuamente exclusivos.	Column
Label	Opcional. Texto a ser exibido para um controle ou grupo. Se um rótulo for especificado, ele substitui qualquer rótulo associado ao campo nos metadados do controle. Necessário para o Tab elemento. Texto a ser exibido por uma guia. LabelText é uma cadeia de caracteres 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 de 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. Cadeia de caracteres do formulário (esquerda, superior, direita, inferior) que especifica, em pixels, a quantidade de espaço em torno do controle e entre o controle e seus vizinhos. Você pode variar a quantidade de espaço em cada lado. Valor do padrão: ^ $\d+\,\d+\,\d+\,\d+$$ Exemplo de valor padrão: (2,0,2,0)	Control Group Layout Tab TabGroup
MinimumSize	Opcional. Cadeia de caracteres de formato (largura, altura). Esse valor Especifica o tamanho mínimo para o próprio formulário. Quando o contêiner de controle menor que esse tamanho, barras de rolagem horizontais e verticais são exibidas.	Control Layout
Name	Opcional. Nome do controle. Se não for especificado, o nome é igual a FieldName.	Control
Padding	Opcional. Cadeia de caracteres do formulário (superior, inferior, esquerda, direita) que especifica, em pixels, a quantidade de espaço ao redor da borda externa do controle e para dentro de 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 elemento que o contém. PercentWidthe FixedWidth são mutuamente exclusivos.	Column
ReadOnly	Opcional. Você pode exibir um campo somente leitura em um controle. Controles diferentes respondem a este atributo maneiras ligeiramente diferentes.	Control
Target	Opcional. Cadeia de caracteres que especifica qual cliente esse layout se aplica. Visual Studioexibe esse tipo de item de trabalho neste layout se o Target atributo for omitido ou 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 Team Explorer e Team Explorer Everywhere. Web: Aplica-se o formulário Team Web Access.	Layout
Type	Obrigatório. O tipo do controle. Para obter mais informações, consulte Referência do elemento XML de controle.	Control

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

O WebpageControlOptions elemento e seus elementos filhos têm 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>

Use os elementos descritos na tabela a seguir para definir o texto sem formatação ou rótulos com hiperlinks, 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 Fornecer texto da ajuda, hiperlinks ou conteúdo da Web em um formulário de item de trabalho.

Elemento	Obrigatório?	Descrição
Content	Opcional WebpageControlOptions elemento.	Especifica o conteúdo baseado em HTML 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 WebpageControlOptions.
LabelText	Opcional Control elemento quando type="LabelControl".	Define ou um rótulo simples ou com hiperlinks. Para obter mais informações, consulte Referência de elementos XML LabelText e Text.
Link	Opcional Control elemento quando type="FieldControl". Opcional Text elemento. Opcional WebpageControl elemento. Opcional WebpageControlOptions elemento.	Define o hiperlink para um campo, o rótulo ou o conteúdo de navegador da Web seja exibido em um formulário de item de trabalho. `<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters"> <Param /> </Link>` Para obter mais informações, consulte Referência de elementos XML para link e parâmetro.
Param	Opcional Link elemento.	Especifica um valor para determinar o URL do hiperlink quando URLPath for especificado para o Link elemento. `<Param index="IndexValue " value="ParamValue " type ="Original \| Current"/>` Para obter mais informações, consulte Referência de elementos XML para link e parâmetro.
Text	Opcional LabelText elemento.	Elemento contêiner para as informações ou o rótulo a ser exibido 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 Text.
WebpageControlOptions	Opcional Control elemento quandotype="WebpageControl"	Elemento de contêiner que especifica as opções para o controle de página da Web. Para obter mais informações, consulte Referência de elementos XML WebpageControlOptions.

Elementos que filtrar e exibem as relações de link

Você usa 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 exibir a lista de links em um item de trabalho. Quando você adiciona um controle de link a um formulário de item de trabalho, você pode especificar filtros que restringem os tipos de links que os usuários podem criar e os tipos de itens de trabalho entre os quais os usuários podem criar vínculos. O LinksControlOptions elemento e seus elementos filhos têm 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 são resumidos na tabela a seguir. Para obter mais informações sobre como usar esses elementos, consulte Definir controles de link para restringir as relações de link e Elementos LinksControlOptions.

Elemento	Obrigatório?	Descrição
LinksControlOptions	Opcional Control elemento quandotype="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 uma ou mais Filter elementos que especificam o link filtragem critérios a serem usados para tipos de link definidos para a coleção de projetos de equipe.
ExternalLinkFilters	Opcional LinksControlOptions elemento	Fornece um contêiner para uma ou mais Filter elementos que especificam os critérios de filtro a ser usado para vincular os tipos que são definidos em outros projetos de equipe.
WorkItemTypeFilters	Opcional LinksControlOptions elemento	Fornece um contêiner para uma ou mais Filter elementos que especificam os critérios de filtro a ser aplicado a tipos de item de trabalho.
Filter(tipos de link)	Necessário WorkItemLinkFilters elemento quando o FilterType é exclude ou include. Necessário ExternalLinkFilters elemento quando o FilterType é exclude ou include.	Especifica os tipos de links a serem incluídos ou excluídos do conjunto de links que podem ser criadas para o item de trabalho.
Filter(tipos de item de trabalho)	Opcional WorkItemTypeFilters elemento quando o FilterType é 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 uma ou mais LinkColumn marcas.
LinkColumn	Necessário LinkColumns elemento	Especifica os campos do item de trabalho e atributos de tipo de link seja exibido no formulário de item de trabalho para a lista de links.

Compartilhar via

Todas as referências de elementos XML FORM

Exemplo de formulário

Elementos de formulário

Atributos que são usados para formatar 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 as relações de link

Consulte também

Conceitos

Outros recursos

Recursos adicionais