Referencia de elementos Control de XML

Se usa el Control para definir un campo de elemento de trabajo, texto, hipervínculo u otro elemento de control que aparecerá en un formulario de elemento de trabajo. Para obtener ejemplos de cómo se utiliza este elemento , vea Especificar controles de formulario de elemento de trabajo. Para obtener más información, vea Diseñar y personalizar un formulario de elementos de trabajo.

Jerarquía del esquema

WITD

   WORKITEMTYPE

       FORM

           Diseño

               Grupo

               Columna

               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 y elementos

En las secciones siguientes se describen los atributos, los elementos secundarios y los elementos primarios.

Atributos

Atributo

Descripción

FieldName

Atributo ControlType opcional.

Especifica el campo de elemento de trabajo al que está asociado el control. El tipo de atributo es typelib:ReferenceFieldName. Longitud mínima: 1; longitud máxima: 70.

Valor de modelo: ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

Ejemplo de un valor de modelo: Company.Division.IssueType

Type

El atributo ControlType es obligatorio.

Especifica el tipo de datos del control. El tipo de atributo es un tipo simple ValidControlsType. Defina una cadena a partir de uno de los tipos integrados siguientes:

  • AttachmentControl: Se utiliza para mostrar los datos adjuntos del elemento de trabajo. Este control no tiene asociado ningún campo o tipo de campo.

  • DateTimeControl: Se usa para mostrar los campos de fecha con formato con un tipo de campo DateTime.

  • FieldControl: Se usa para mostrarse campos de texto sin formato o numéricos y listas de valores para los campos con un tipo de campo de String, Identity, Integer, Double y PlainText.

  • HtmlFieldControl: Se usa para mostrar formato de texto enriquecido multilínea de campos con un tipo de campo de HTML.

  • LabelControl: Se utiliza para mostrar texto sin formato que no está asociado a un campo. El texto puede ser sin formato o hipervinculado.

  • LinksControl: Se utiliza para mostrar los vínculos del elemento de trabajo. Este control no tiene asociado ningún campo o tipo de campo.

  • WebpageControl: Se usa para mostrar contenido basado en HTML definido por un URI o incrustado dentro de una etiqueta de CDATA. Este control no tiene asociado ningún campo o tipo de campo.

  • WorkItemClassificationControl Usado para mostrar los campos de ruta de acceso jerárquicos con un tipo de campo TreePath.

    NotaNota
    Los campos System.AreaPath y System.IterationPath son los únicos campos que utilizan este tipo de datos.No puede definir ningún campo personalizado utilizando este tipo de datos.
  • WorkItemLogControl: Se utiliza para mostrar información de historial y campos del elemento de trabajo con un tipo de campo History.

    NotaNota
    El campo System.History es el único campo que utiliza este tipo de datos.No puede definir ningún campo personalizado utilizando este tipo de datos.

Para obtener más información, vea Especificar controles de formulario de elemento de trabajo.

NotaNota
Puede utilizar un control personalizado estableciendo el atributo Type en un valor personalizado.Todos los controles cuyo valor Type no coincida con el nombre de un tipo integrado se consideran controles personalizados.Para obtener más información, vea el sitio web de Microsoft: Work Item Tracking Custom Controls.

Label

Atributo ControlType opcional.

Especifica el texto visible en el formulario que identifica el control. Escriba una cadena que no supere los 80 caracteres.

LabelPosition

Atributo ControlType opcional.

Especifica la posición de la etiqueta en relación con los datos del control. Defina una cadena a partir de uno de los valores siguientes:

  • Top: coloca la etiqueta encima de los datos del control.

  • Bottom: coloca la etiqueta debajo de los datos del control.

  • Left: coloca la etiqueta a la izquierda de los datos del control.

  • Right: coloca la etiqueta a la derecha de los datos del control.

Dock

Atributo ControlType opcional.

Alinea el campo con el lado especificado del contenedor o ajusta el campo de modo que rellene el contenedor. El tipo de atributo es DockType. Defina una cadena a partir de uno de los valores siguientes:

  • Fill: alinea el campo para que rellene el contenedor. Este valor no es una orientación compatible para el elemento Splitter.

  • Top: Alinea el campo con la parte superior del contenedor. Este valor no es una orientación compatible para el elemento Splitter.

  • Bottom: Alinea el campo con la parte inferior del contenedor. Este valor no es una orientación compatible para el elemento Splitter.

  • Left: Alinea el campo con la parte izquierda del contenedor.

  • Right: Alinea el campo con la parte derecha del contenedor. Este valor no es una orientación compatible para el elemento Splitter.

Padding

Atributo ControlType opcional.

Especifica la cantidad de espacio en píxeles alrededor del borde interior del control, que corresponde a los espacios superior, inferior, izquierdo y derecho. El tipo de atributo es SizeType.

Valor de modelo: ^\(\d+\,\d+\,\d+\,\d+\)$

Ejemplo de un valor de modelo: (2,0,2,0)

Margin

Atributo ControlType opcional.

Especifica la cantidad de espacio en píxeles alrededor del borde exterior del control, que corresponde a los espacios superior, inferior, izquierdo y derecho. El tipo de atributo es SizeType.

Valor de modelo: ^\(\d+\,\d+\,\d+\,\d+\)$

Ejemplo de un valor de modelo: (2,0,2,0)

ReadOnly

Atributo ControlType opcional.

Especifica si el campo es de sólo lectura. El tipo de atributo es ReadOnlyType. Defina una cadena a partir de uno de los valores siguientes:

  • True: especifica que los datos del control son de solo lectura.

  • False: especifica que los datos del control no son de solo lectura.

MinimumSize

Atributo ControlType opcional.

Especifica el tamaño mínimo en píxeles que debería ocupar el control en el formulario. La sintaxis se especifica en (width,height). El tipo de atributo es SizeType.

Valor de modelo: ^\(\d+\,\d+\)$

Ejemplo de un valor de modelo: (100,100)

NotaNota
Si no tiene espacio vertical suficiente, aparecerá una barra de desplazamiento para mantener su tamaño mínimo.Sin este atributo, los controles se dibujan con sus tamaños predeterminados, a menos que haya controles en otras pestañas que ocupen más espacio.El tamaño total de cualquier control de formulario depende del tamaño del área de formulario o pestaña más grande.

Name

Atributo ControlType opcional.

Identifica un control de forma única. Name es importante si hay varios controles en el formulario asociados al mismo campo de elemento de trabajo. El tipo de atributo es xs:string.

NotaNota
El atributo Name se usa cuando se desea mostrar el mismo campo en más de una ubicación del formulario.Se especifica un valor único para el atributo Name de ambas entradas de control a fin de que el sistema identifique cada control de forma exclusiva.Es útil para mostrar el mismo control en varias ubicaciones en función del contexto de pestañas.

NumberFormat

Atributo ControlType opcional que solo es válido cuando se utiliza con FieldControl.

Especifica los caracteres que se pueden escribir en el control de campo. Los valores válidos que puede utilizar son los siguientes:

  • WholeNumbers: Especifica que se permiten los números enteros.

  • SignedWholeNumbers: Especifica que se permiten los números enteros firmados.

  • DecimalNumbers: Especifica que se permiten los números decimales.

  • SignedDecimalNumbers: Especifica que se permiten los números decimales firmados.

MaxLength

Atributo ControlType opcional que solo es válido cuando se utiliza con FieldControl.

Especifica la longitud máxima de los caracteres permitidos para un control de campo. El tipo de atributo es xs:integer.

Format

Atributo ControlType opcional que solo es válido cuando se utiliza con DateTimeControl.

Especifica el formato para el campo de fecha y hora que corresponde a uno de los valores de la enumeración DateTimePickerFormat. Los valores válidos que puede utilizar son los siguientes:

  • Custom: Muestra el valor de fecha y hora en un formato personalizado. El formato personalizado se puede establecer especificando 'Custom' como valor para el atributo Format y estableciendo otro atributo denominado CustomFormat con una cadena de formato personalizado. Por ejemplo:

    Format="Custom"

    CustomFormat = "MMM dd, 'del año' yyyy"

    Para obtener más información, vea en el sitio web de Microsoft: DateTimePicker.CustomFormat (Propiedad).

  • Long: muestra el valor de fecha y hora con el formato de fecha larga establecido por el sistema operativo del usuario.

  • Short: muestra el valor de fecha y hora con el formato de fecha corta establecido por el sistema operativo del usuario.

  • Time: muestra el valor de fecha y hora con el formato de hora establecido por el sistema operativo del usuario.

Para obtener información, vea DateTimePickerFormat (Enumeración) en el sitio web de MSDN.

CustomFormat

Atributo ControlType opcional que solo es válido cuando se utiliza con los atributos Format y DateTimeControl.

Especifica el formato personalizado para el campo de fecha y hora que corresponde a la sintaxis definida para la propiedad DateTimePicker.CustomFormat. Para obtener más información, vea en el sitio web de Microsoft: DateTimePicker.CustomFormat (Propiedad).

Elementos secundarios

Elemento

Descripción

LabelText

Elemento opcional. Puede especificar este elemento cuando ControlType se especifica como FieldControl o LabelControl.

Elemento contenedor que se usa para especificar texto, hipervínculo y posición de un campo o etiqueta cuyo texto está asociado en parte a un hipervínculo.

Para obtener más información, vea Referencia de los elementos LabelText y Text de XML y Proporcionar texto de ayuda, guía de procesos, contenido web y vínculos con páginas web en un formulario de elemento de trabajo.

Link

Elemento opcional. Puede especificar este elemento cuando ControlType se especifica como FieldControl o LabelControl.

Define el hipervínculo para un campo o etiqueta.

Para obtener más información, vea Referencia de los elementos Link y Param de XML y Proporcionar texto de ayuda, guía de procesos, contenido web y vínculos con páginas web en un formulario de elemento de trabajo.

LinksControlOptions

Elemento opcional. Puede especificar este elemento cuando ControlType se especifica como LinksControl.

Define los filtros de los vínculos y el diseño de los campos de columna que se utilizan para mostrar la lista de vínculos.

Para obtener más información, vea Definir controles de vínculos para restringir las relaciones de los vínculos.

WebpageControlOptions

Elemento opcional. Puede especificar este elemento cuando ControlType es WebpageControl.

Especifica los controles que rigen la carga del destino de la página web en el formulario de elemento de trabajo.

Para obtener más información, vea WebpageControlOptions (Referencia de elementos de XML) y Proporcionar texto de ayuda, guía de procesos, contenido web y vínculos con páginas web en un formulario de elemento de trabajo.

anyAttribute

Elemento opcional.

Opcional. ControlType se puede extender mediante el uso del elemento anyAttribute. ProcessContents: skip.

Elementos primarios

Elemento

Descripción

Diseño

Obligatorio. Define cómo mostrar los elementos en el formulario del elemento de trabajo.

Elemento Column

Obligatorio. Define las columnas del formulario.

Elemento Tab

Obligatorio. Define una pestaña del formulario.

Comentarios

Control es un elemento secundario opcional de Layout, Column y Tab.

Indicadores Layout y Column:

minOccurs = "0"

maxOccurs = "1"

Indicadores Tab:

minOccurs = "0"

maxOccurs = "unbounded"

Para implementar un control personalizado, debe especificar el nombre del control para el atributo Type. Para obtener más información, vea el sitio web de Microsoft: Work Item Tracking Custom Controls.

Para obtener un ejemplo de cada tipo de control, vea Especificar controles de formulario de elemento de trabajo.

Ejemplo

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

Información de elemento

Espacio de nombres

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

Nombre de esquema

Definición del tipo de elemento de trabajo

Archivo de validación

WorkItemTypeDefinition.xsd

Tipo de elemento

Tipo complejo ControlType

Puede estar vacío

No es aplicable

Vea también

Conceptos

Diseñar y personalizar un formulario de elementos de trabajo

Referencia de todos los elementos FORM de XML

Especificar controles de formulario de elemento de trabajo

Historial de cambios

Fecha

Historial

Motivo

Enero de 2011

Se agregan elementos secundarios a la sintaxis, se quitan o reemplazan los vínculos a los temas que se han quitado.

Mejora de la información.