Partilhar via


Referência de elemento do controle XML

Você pode usar o Control elemento para definir um campo de item de trabalho, o texto, o hiperlink ou outro elemento de controle para exibir em um formulário de item de trabalho. Para obter exemplos de como usar esse elemento, consulte Especificando os controles de formulário de Item de trabalho. Para obter mais informações, consulte Criando e personalizando um formulário de Item de trabalho.

Hierarquia de esquema

WITD

   WORKITEMTYPE

       FORMULÁRIO

           Layout

               Group

               Coluna

               Tab

<xs:element name="Control" type="ControlType" minOccurs="0"/>

<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" >
<LabelText> . . . </LabelText>
<Link> . . . </Link>
<LinksControlOptions> . . . </LinksControlOptions>
<WebpageControlOptions> . . . </WebpageControlOptions>
</Control>

Atributos e elementos

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

Atributos

Atributo

Descrição

FieldName

Opcional ControlType atributo.

Especifica o campo de item de trabalho ao qual o controle está associado. O tipo de atributo é typelib:ReferenceFieldName. Comprimento mínimo: 1; comprimento máximo: 70.

Valor padrão: ^[a-Za-Z_][a-Za-z0-9_]* (\. [a-zA-Z0-9 _] +) +$

Exemplo de valor padrão: Company.Division.IssueType

Type

Obrigatório ControlType atributo.

Especifica o tipo de dados do controle. O tipo de atributo é ValidControlsType tipo simples. Especifique uma seqüência de caracteres de um dos seguintes tipos internos:

  • AttachmentControl: Use para exibir os anexos de item de trabalho. Esse controle não tem um campo associado ou o tipo de campo.

  • DateTimeControl: Use para exibir os campos de data formatada com um tipo de campo de DateTime.

  • FieldControl: Use para exibir os campos de textuais ou numéricos simples e listas de valores para campos com um tipo de campo de String, Identity, Integer, Double, e PlainText.

  • HtmlFieldControl: Use para exibir o formato rich text, de várias linhas dos campos com um tipo de campo de HTML.

  • LabelControl: Use para exibir o texto que não está associado um campo. O texto pode ser simples ou hiperlink.

  • LinksControl: Use esta opção para exibir links de item de trabalho. Esse controle não tem um campo associado ou o tipo de campo.

  • WebpageControl: Use para exibir o conteúdo baseado em HTML definido por um URI ou incorporado em uma tag CDATA. Esse controle não tem um campo associado ou o tipo de campo.

  • WorkItemClassificationControlUse para exibir os campos de caminho hierárquico com um tipo de campo de TreePath.

    ObservaçãoObservação
    O System.AreaPath e System.IterationPath campos são os únicos campos que usam esse tipo de dados.Você não pode definir um campo personalizado usando o tipo de dados.
  • WorkItemLogControl: Use para exibir informações de histórico de item de trabalho e os campos com um tipo de campo de History.

    ObservaçãoObservação
    O System.History campo é o único campo que usa esse tipo de dados.Você não pode definir um campo personalizado usando o tipo de dados.

Para obter mais informações, consulte Especificando os controles de formulário de Item de trabalho.

ObservaçãoObservação
Você pode usar um controle personalizado, definindo a Type atributo para um valor personalizado.Qualquer controle cuja Type valor não corresponder ao nome de uma interna tipo é considerado um controle personalizado.Para obter mais informações, consulte o site da Microsoft: Controles personalizados de rastreamento de Item de trabalho.

Label

Opcional ControlType atributo.

Especifica o texto visível no formulário que identifica o controle. Especifique uma seqüência de caracteres não mais de 80.

LabelPosition

Opcional ControlType atributo.

Especifica a posição do rótulo em relação aos dados de controle. Especifique uma seqüência de caracteres de um dos seguintes valores:

  • Top: Coloca o rótulo acima os dados de controle.

  • Bottom: Coloca o rótulo abaixo dos dados de controle.

  • Left: Coloca o rótulo à esquerda dos dados de controle.

  • Right: Coloca o rótulo à direita dos dados de controle.

Dock

Opcional ControlType atributo.

Alinha o campo com o lado especificado do recipiente ou estica o campo para preencher o recipiente. O tipo de atributo é DockType. Especifique uma seqüência de caracteres de um dos seguintes valores:

  • Fill: Alinha o campo para que ela preencha o recipiente. Esse valor não é uma orientação com suporte para o Splitter elemento.

  • Top: Alinha o campo junto com a parte superior do recipiente. Esse valor não é uma orientação com suporte para o Splitter elemento.

  • Bottom: Alinha o campo junto com a parte inferior do recipiente. Esse valor não é uma orientação com suporte para o Splitter elemento.

  • Left: Alinha o campo com o lado esquerdo do recipiente.

  • Right: Alinha o campo com o lado direito do recipiente. Esse valor não é uma orientação com suporte para o Splitter elemento.

Padding

Opcional ControlType atributo.

Especifica a quantidade de espaço em pixels ao redor do interior borda do controle que corresponde à parte superior, inferior, esquerda e espaços à direita. O tipo de atributo é SizeType.

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

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

Margin

Opcional ControlType atributo.

Especifica a quantidade de espaço em pixels ao redor da borda externa do controle que corresponde à parte superior, inferior, esquerda e espaços à direita. O tipo de atributo é SizeType.

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

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

ReadOnly

Opcional ControlType atributo.

Especifica que o campo é somente leitura. O tipo de atributo é ReadOnlyType. Especifique uma seqüência de caracteres de um dos seguintes valores:

  • True: Especifica que os dados de controle serão somente leitura.

  • False: Especifica que os dados de controle não não somente leitura.

MinimumSize

Opcional ControlType atributo.

Especifica o tamanho mínimo em pixels que o controle deve ocupar no formulário. A sintaxe é especificada em (width,height). O tipo de atributo é SizeType.

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

Exemplo de valor padrão: (100,100)

ObservaçãoObservação
Se você não tem suficiente espaço vertical, aparece uma barra de rolagem para manter o seu tamanho mínimo.Sem esse atributo, os controles são desenhados com seus tamanhos padrão, a menos que os controles em outras guias levar mais espaço.O tamanho total de qualquer controle de um formulário depende do tamanho da maior área de formulário ou na guia.

Name

Opcional ControlType atributo.

Identifica um controle com exclusividade. O Name é importante se mais de um controle no formulário está associado com o mesmo trabalho item campo. O tipo de atributo é xs:string.

ObservaçãoObservação
Você pode usar o Name atributo quando você deseja ter o mesmo campo exibido em mais de um local no formulário.Você especificar um valor exclusivo para o Name de atributo para ambas as entradas de controle para que o sistema identifica cada controle exclusivamente.É útil mostrar o mesmo controle em vários locais, baseadas no contexto das guias.

NumberFormat

Opcional ControlType atributo que só é válido quando ele é usado com FieldControl.

Especifica os caracteres que podem ser inseridas no controle de campo. Os valores válidos, você pode usar são:

  • WholeNumbers: Especifica que os números inteiros são permitidos.

  • SignedWholeNumbers: Especifica que os números de inteiros assinados são permitidos.

  • DecimalNumbers: Especifica que os números decimais são permitidos.

  • SignedDecimalNumbers: Especifica que os números decimais assinados são permitidos.

MaxLength

Opcional ControlType atributo que só é válido quando ele é usado com FieldControl.

Especifica o comprimento máximo de caracteres permitidos para um controle de campo. O tipo de atributo é xs:integer.

Format

Opcional ControlType atributo que só é válido quando ele é usado com DateTimeControl.

Especifica o formato do campo de data e hora que corresponde a um dos valores de enum DateTimePickerFormat. Os valores válidos, você pode usar são:

  • Custom: Exibe o valor de data/hora em um formato personalizado. O formato personalizado pode ser definido especificando 'Personalizado' como o valor para o atributo de formato e a configuração o outro atributo chamado CustomFormat com uma seqüência de caracteres de formato personalizado. Por exemplo:

    Formato = "Personalizado"

    CustomFormat = "MMM dd, 'do ano' aaaa"

    Para obter mais informações, consulte o site da Microsoft: A propriedade de DateTimePicker.CustomFormat.

  • Long: Exibe o valor de data/hora no formato de data por extenso, definido pelo sistema operacional do usuário.

  • Short: Exibe o valor de data/hora no formato de data abreviada definido pelo sistema operacional do usuário.

  • Time: Exibe o valor de data/hora no formato de hora definido pelo sistema operacional do usuário.

Para obter mais informações, consulte o site da Microsoft: A enumeração de DateTimePickerFormat.

CustomFormat

Opcional ControlType atributo que só é válido quando ele é usado com DateTimeControl e o Format atributo.

Especifica o formato personalizado para o campo de data e hora correspondente a sintaxe definida para a propriedade DateTimePicker.CustomFormat. Para obter mais informações, consulte o site da Microsoft: A propriedade de DateTimePicker.CustomFormat.

Elementos filho

Elemento

Descrição

LabelText

Elemento opcional. Você pode especificar esse elemento quando ControlType é especificado como FieldControl ou LabelControl.

Elemento de contêiner para especificar o texto, o hiperlink e a posição de um campo ou rótulo cujo texto está parcialmente associado um hiperlink.

Para obter mais informações, consulte Referência de elementos XML LabelText e texto e 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.

Link

Elemento opcional. Você pode especificar esse elemento quando ControlType é especificado como FieldControl ou LabelControl.

Define o hiperlink para um campo ou rótulo.

Para obter mais informações, consulte Link e referência de elementos XML de Param e 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.

LinksControlOptions

Elemento opcional. Você pode especificar esse elemento quando ControlType é especificado como LinksControl.

Define os filtros de link e o layout dos campos de coluna para exibir a lista de links.

Para obter mais informações, consulte Definir controles de Link para restringir os relacionamentos de Link.

WebpageControlOptions

Elemento opcional. Você pode especificar esse elemento quando ControlType é WebpageControl.

Especifica os controles que regem o destino da página da Web no formulário de item de trabalho de carregamento.

Para obter mais informações, consulte Referência de elementos XML de WebpageControlOptions e 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.

anyAttribute

Elemento opcional.

Opcional. ControlTypeé extensível, através do uso de anyAttribute elemento. ProcessContents: ignore.

Elementos pai

Elemento

Descrição

Layout

Obrigatório. Define como exibir os elementos do formulário de item de trabalho.

Coluna elemento

Obrigatório. Define as colunas para o formulário.

Guia elemento

Obrigatório. Define uma guia para o formulário.

Comentários

Controlé um elemento filho opcional de Layout, Column, e Tab.

Layoute Column indicadores:

minOccurs = "0"

maxOccurs = "1"

Tabindicadores:

minOccurs = "0"

maxOccurs = "não vinculado"

Para implementar um controle personalizado, você deve especificar o nome do controle para o Type atributo. Para obter mais informações, consulte o site da Microsoft: Controles personalizados de rastreamento de Item de trabalho.

Para obter um exemplo de cada tipo de controle, consulte Especificando os controles de formulário de Item de trabalho.

Exemplo

<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
  Label="Area" LabelPosition="Left" />

Informações do elemento

Namespace

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

Nome de esquema

Definição de tipo de Item de trabalho

Arquivo de validação

WorkItemTypeDefinition.xsd

Tipo de elemento

Tipo de ControlType complexo

Pode ficar vazio

Não aplicável.

Consulte também

Conceitos

Criando e personalizando um formulário de Item de trabalho

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

Especificando os controles de formulário de Item de trabalho

Histórico de alterações

Date

History

Motivo

Janeiro de 2011

Elementos filho adicionados a sintaxe, removidos ou substituídos de links para tópicos que foram removidos.

Aprimoramento de informações.