Referencia del elemento Control de XML

  • Artículo

El elemento Control se usa 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 usar este elemento, vea Especificar controles de formulario de elemento de trabajo y Diseñar el formulario de elemento de trabajo.

Jerarquía del esquema

WITD

   WORKITEMTYPE

       FORM

           Diseño

               Agrupar

               Columna

               Tabulador

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

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

Atributos

Atributo

Descripción

FieldName

Atributo Control 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 Control es obligatorio.

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

  • AttachmentControl: se usa 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 mostrar campos de texto sin formato o numéricos y listas de valores para los campos de tipo String, Identity, Integer, Double y PlainText.

  • HtmlFieldControl: se usa para mostrar formato de texto enriquecido multilínea de campos de tipo HTML.

  • LabelControl: se usa para mostrar texto no asociado a un campo. El texto puede ser sin formato o hipervinculado. Se pueden especificar controles adicionales mediante los elementos LabelText, Link y Text. Vea Referencia de los elementos LabelText y Text de XML y Referencia de los elementos Link y Param de XML.

  • LinksControl: se usa para mostrar la barra de herramientas de control de vínculos y administrar las relaciones de vínculos entre los elementos de trabajo y los guiones gráficos. Este control no tiene asociado ningún campo o tipo de campo. Los tipos de vínculos para filtrar y otras opciones de control se especifican mediante el elemento LinksControlOptions. Vea Elementos LinksControlOptions.

  • WebpageControl: se usa para mostrar contenido basado en HTML definido por un URI o incrustado en una etiqueta de CDATA. Este control no tiene asociado ningún campo o tipo de campo. . Use el elemento WebpageControlOptions para especificar el contenido y los vínculos. Vea Referencia de elementos XML WebpageControlOptions.

  • WorkItemClassificationControl: se usa para mostrar los campos de ruta de acceso jerárquicos con un tipo TreePath.

    Nota

    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 usa para mostrar información del historial del elemento de trabajo y los campos de tipo History.

    Nota

    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 más información, vea el tema sobre Especificar controles de formulario de elemento de trabajo.

Nota

Puede usar 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 más información, vea el sitio web de Microsoft: Controles personalizados para el seguimiento de elementos de trabajo.

ControlFontSize

Atributo Control opcional.

Especifica el tamaño de fuente del nombre de campo o de la etiqueta del formulario. Los valores válidos para FontSize son: small, normal, large, xlarge y xxlarge.

EmptyText

Atributo Control opcional.

Especifica una cadena de texto que contiene entre 1 y 255 caracteres y que aparece cuando un campo está vacío.

Label

Atributo Control opcional.

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

LabelFontSize

Especifica el tamaño de fuente de la etiqueta del formulario. Los valores válidos para FontSize son: small, normal, large, xlarge y xxlarge.

LabelPosition

Atributo Control opcional.

Especifica la posición de la etiqueta en relación con los datos del control. Especifique 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.

Padding

Atributo Control 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 Control 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 Control opcional.

Especifica si el campo es de sólo lectura. El tipo de atributo es ReadOnlyType. Especifique 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 Control opcional.

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

Valor de patrón: ^\(\d+\,\d+\)$

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

Nota

Si no tiene espacio vertical suficiente, aparecerá una barra de desplazamiento para mantener el 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 de la pestaña o área de formulario más grande.

Name

Atributo Control opcional.

Identifica un control de forma exclusiva. 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.

Nota

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 Control opcional que solo es válido cuando se usa con FieldControl.

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

  • WholeNumbers: especifica que se permiten números enteros.

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

  • DecimalNumbers: especifica que se permiten números decimales.

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

MaxLength

Atributo Control opcional que solo es válido cuando se usa 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 Control opcional que solo es válido cuando se usa 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 usar son los siguientes:

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

    Format="Custom"

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

    Para más información, visite 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 más información, visite el sitio web de Microsoft: DateTimePickerFormat (Enumeración).

CustomFormat

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

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

Elementos secundarios

Elemento

Descripción

LabelText

Elemento opcional. Se puede especificar este elemento cuando el atributo Type tiene como valor FieldControl o LabelControl.

Elemento contenedor que se usa para especificar el texto, el hipervínculo y la 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, hipervínculos o contenido web en un formulario de elemento de trabajo.

Vínculo

Elemento opcional. Se puede especificar este elemento cuando el atributo Type tiene como valor 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, hipervínculos o contenido web en un formulario de elemento de trabajo.

LinksControlOptions

Elemento opcional. Se puede especificar este elemento cuando el atributo Type tiene como valor LinksControl.

Define los filtros de los vínculos y el diseño de los campos de columna que se usan 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. Se puede especificar este elemento cuando el atributo Type tiene como valor 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 Referencia de elementos XML WebpageControlOptions y Proporcionar texto de ayuda, hipervínculos o contenido web en un formulario de elemento de trabajo.

anyAttribute

Elemento opcional.

Opcional. Control se puede extender mediante el uso del elemento anyAttribute.

Elementos primarios

Elemento

Descripción

Diseño

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

Elemento Column

Requerido. Define las columnas del formulario.

Elemento Tab

Requerido. 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 más información, vea el sitio web de Microsoft: Controles personalizados para el seguimiento de elementos de trabajo.

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

Ejemplo

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

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 aplicable

Vea también

Conceptos

Referencia de todos los elementos FORM de XML

Especificar controles de formulario de elemento de trabajo

Otros recursos

Diseñar y personalizar un formulario de elemento de trabajo