Compartilhar via

Referência do elemento XML de controle

  • Artigo

Você usa o Control elemento para definir um campo de item de trabalho, texto, hiperlinks ou outro elemento de controle para exibir em um formulário de item de trabalho. Para obter exemplos de como usar esse elemento, consulte Especificar controles de formulários de itens de trabalho e Criar o formulário de item de trabalho.

Hierarquia de esquema

WITD

   WORKITEMTYPE

       FORMULÁRIO

           Layout

               Grupo

               Coluna

               Tab

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

<Control FieldName="FieldName" Type="AttachmentsControl | DateTimeControl | FieldControl | 
HtmlFieldControl | LabelControl | LinksControl | WebpageControl | WorkItemClassificationControl | 
WorkItemLogControl" ControlFontSize="FontSize" EmptyText="TextString"
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" >
<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

Atributo Control opcional.

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 do padrão: ^[a-zA-Z_][a-zA-Z0-9_]* (\. [a-zA-Z0-9 _] +) + $

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

Type

Atributo Control obrigatório.

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

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

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

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

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

  • LabelControl: Use para exibir o texto que não esteja associado um campo. O texto pode ser simples ou com hiperlinks. Você pode especificar os controles adicionais usando o LabelText, Link e Text elementos. Consulte Referência de elementos XML LabelText e Text e Referência de elementos XML Link e Param.

  • LinksControl: Use para exibir a barra de ferramentas de controle de links e gerenciar relações de vínculos entre itens de trabalho e storyboards. Esse controle não tem um tipo de campo ou um campo associado. Especificar os tipos de vínculos para filtrar e outras opções de controle usando o LinksControlOptions elemento. Consulte Elementos LinksControlOptions.

  • WebpageControl: Use para exibir conteúdo baseado em HTML definidas por um URI ou incorporados em uma marca CDATA. Esse controle não tem um tipo de campo ou um campo associado. . Especificar o conteúdo e os links a serem exibidos usando o WebpageControlOptions elemento. Consulte Referência de elementos XML WebpageControlOptions.

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

    Dica

    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 esse tipo de dados.

  • WorkItemLogControl: Use para exibir informações do histórico de item de trabalho e campos com um tipo de campo de History.

    Dica

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

Para obter mais informações, consulte Especificar controles de formulários de itens de trabalho.

Dica

Você pode usar um controle personalizado, definindo o Type de atributo para um valor personalizado.Qualquer controle cuja Type valor não coincide com o nome do internos tipo é considerado um controle personalizado.Para obter mais informações, consulte o site da Microsoft: controles personalizados de rastreamento de Item de trabalho.

ControlFontSize

Atributo Control opcional.

Especifica o tamanho da fonte do rótulo ou nome do campo no formulário. Os valores válidos de FontSize: small, normal, large, xlarge, e xxlarge.

EmptyText

Atributo Control opcional.

Especifica uma cadeia de caracteres de texto entre 1 e 255 caracteres que aparece quando um campo está vazio.

Label

Atributo Control opcional.

Especifica o texto visível no formulário que identifica o controle. Especifique uma cadeia de caracteres de no máximo 80 caracteres.

LabelFontSize

Especifica o tamanho da fonte do rótulo no formulário. Os valores válidos para FontSize: small, normal, large, xlarge, e xxlarge.

LabelPosition

Atributo Control opcional.

Especifica a posição do rótulo em relação aos dados de controle. Especifique uma cadeia 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.

Padding

Atributo Control opcional.

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 do padrão: ^ \(\d+\,\d+\,\d+\,\d+\)$

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

Margin

Atributo Control opcional.

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 do padrão: ^ \(\d+\,\d+\,\d+\,\d+\)$

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

ReadOnly

Atributo Control opcional.

Especifica que o campo é somente leitura. O tipo de atributo é ReadOnlyType. Especifique uma cadeia 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 são somente leitura.

MinimumSize

Atributo Control opcional.

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 do padrão: ^ \(\d+\,\d+\)$

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

Dica

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

Name

Atributo Control opcional.

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

Dica

Você usa o Name atributo quando você deseja ter o mesmo campo exibido em mais de um local no formulário.Você especifica um valor exclusivo para o atributo Name para ambas as entradas de controle para que o sistema identifique exclusivamente cada controle.É útil mostrar o mesmo controle em vários locais com base no contexto das guias.

NumberFormat

Opcional Control atributo que é válido somente quando ele é usado com FieldControl.

Especifica os caracteres que você pode inserir no controle de campo. Os valores válidos que podem ser usados são os seguintes:

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

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

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

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

MaxLength

Opcional Control atributo que é válido somente 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 Control atributo que é válido somente 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 que podem ser usados são os seguintes:

  • Custom: Exibe o valor de data/hora em um formato personalizado. O formato personalizado pode ser definido especificando 'Custom' como o valor do atributo de formato e definir outro atributo chamado CustomFormat com uma cadeia de caracteres de formato personalizado. Por exemplo:

    Formato = "Custom"

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

    Para obter mais informações, consulte o site da Microsoft: propriedade 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 curto 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: DateTimePickerFormat enumeração.

CustomFormat

Opcional Control atributo que é válido somente 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 CustomFormat. Para obter mais informações, consulte o site da Microsoft: propriedade CustomFormat.

Elementos filho

Elemento

Descrição

LabelText

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

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

Para obter mais informações, consulte Referência de elementos XML LabelText e Text e Fornecer texto da ajuda, hiperlinks ou conteúdo da Web em um formulário de item de trabalho.

Link

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

Define o hiperlink para um campo ou um rótulo.

Para obter mais informações, consulte Referência de elementos XML Link e Param e Fornecer texto da ajuda, hiperlinks ou conteúdo da Web em um formulário de item de trabalho.

LinksControlOptions

Elemento opcional. Você pode especificar esse elemento quando o Type atributo é 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 as relações de link.

WebpageControlOptions

Elemento opcional. Você pode especificar esse elemento quando o Type é 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 WebpageControlOptions e Fornecer texto da ajuda, hiperlinks ou conteúdo da Web em um formulário de item de trabalho.

anyAttribute

Elemento opcional.

Opcional. Control é extensível através do uso de anyAttribute elemento.

Elementos pai

Elemento

Descrição

Layout

Obrigatório. Define como exibir os elementos no 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.

Layout e Column indicadores:

minOccurs = "0"

maxOccurs = "1"

Tab indicadores:

minOccurs = "0"

maxOccurs = "ilimitado"

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 Especificar controles de formulários de itens de trabalho.

Exemplo

<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
  Label="Area" LabelPosition="Left" Padding="(2,0,2,0)" Margin="(2,2,2,2)" />

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

Tipo complexo de ControlType

Pode estar vazio

Não aplicável

Consulte também

Conceitos

Todas as referências de elementos XML FORM

Especificar controles de formulários de itens de trabalho

Outros recursos

Elaborar e personalizar um formulário de item de trabalho