Especificar controles de formulario de elemento de trabajo

Artículo
11/18/2015

Este tema proporciona una referencia rápida al elemento Control, sus elementos secundarios y atributos. Para cada campo o control de formulario que se desee mostrar en un formulario de elemento de trabajo, se agrega un elemento Control.

Puede personalizar un formulario de elemento de trabajo para mostrar información que ayude a su equipo a utilizar el formulario correctamente. Puede agregar campos y controles de elemento de trabajo que le permiten especificar y ver los datos de los que desea realizar un seguimiento.

El elemento Control proporciona nueve valores para el atributo Type que puede utilizar para agregar campos o para mostrar campos o texto sin formato o de hipervínculo. Además, puede definir controles especiales para agregar vínculos y datos adjuntos, mostrar contenido basado en web, o crear su propio control y agregarlo a un formulario de elemento de trabajo.

Agregar campos de elemento de trabajo

Al personalizar el formulario de elemento de trabajo, suele agregar un subconjunto de los campos de elemento de trabajo definidos para el tipo de elemento de trabajo que desea que aparezca en el formulario. Las definiciones de campo controlan numerosos aspectos de los datos que se muestran o de los datos que se pueden especificar en el formulario. Para obtener más información, vea Modificar o agregar un campo para admitir consultas, informes y flujos de trabajo.

Cada campo de elemento de trabajo está asociado a un tipo de datos. Puede utilizar la información de la siguiente tabla para determinar el tipo de campo que un atributo Type del elemento Control admite. Utilice el atributo Label para especificar el texto que se muestra junto al control. Utilice el atributo LabelPosition relacionado para especificar dónde aparece la etiqueta en relación con el control. Para obtener más información, vea Controlar cómo se muestran los campos de elementos de trabajo.

Nota

No puede cambiar los valores de los campos del sistema, que se actualizan automáticamente.Por ejemplo, los campos Fecha de creación y Creado por se definen la primera vez que se guarda un elemento de trabajo.Sin embargo, puede utilizar estos campos en los criterios de búsqueda.Para obtener una descripción de cada campo del sistema, vea Referencia de campos de elementos de trabajo para Visual Studio ALM.

Tipo de campo	Atributo Type del elemento Control	Uso
DateTime	FieldControl DateTimeControl	FieldControl se usa para proporcionar un campo de texto a fin de especificar o mostrar un campo de tipo de datos DateTime. `<Control FieldName=" MyCompany.Group1.StartDate " Type="FieldControl" Label="Start Date" LabelPosition="Left" />` Utilice DateTimeControl para proporcionar un selector de calendario para elegir una fecha para un campo, como se muestra en la siguiente ilustración. `<Control Type="DateTimeControl" FieldName="MyCompany.Group.ScheduleStart" Label="Scheduling Start Date:" LabelPosition="Left" Dock="Fill" Format="Short" />`
Double	FieldControl	FieldControl se usa para proporcionar un campo de texto a fin de especificar o mostrar campos Double. `<Control FieldName="ABC_Company.Statistics.Analysis" Type="FieldControl" Label="Analysis %" LabelPosition="Left" />`
History	WorkItemLogControl	Utilice WorkItemLogControl para proporcionar un campo de control para los campos de historial que realizan el seguimiento de los hilos de discusión y otra información histórica, como se muestra en la siguiente ilustración. Puede utilizar este control solo para admitir la presentación del campo de historial de un elemento de trabajo, el campo de elemento de trabajo System.History. Con este control, puede expandir y contraer los detalles sobre las revisiones históricas de un elemento de trabajo. También puede aplicar formato al texto que agregue al campo de historial. `<Control Type="WorkItemLogControl" FieldName="System.History" Label="Detailed Description and History" LabelPosition="Top" Dock="Fill" />`
HTML	HTMLControl	Utilice HTMLControl para proporcionar un campo de control que permita a los campos HTML capturar formato de texto enriquecido, como se muestra en la siguiente ilustración. `<Control Type="HtmlFieldControl" FieldName="Microsoft.VSTS.Notes" Label="Notes" Dock="Fill" />`
Integer	FieldControl	FieldControl se usa para proporcionar un campo de control para un campo Integer. `<Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />`
PlainText	FieldControl	Utilice FieldControl para proporcionar un campo de control para un campo PlainText, como un cuadro de texto con descripciones que pueden superar los 255 caracteres. `<Control FieldName="Microsoft.VSTS.DocName" Type="FieldControl" Label="Vision Doc Location" LabelPosition="Left" />`
String	FieldControl	FieldControl se usa para proporcionar un campo de control para un campo String. Los campos String se limitan a 255 caracteres. `<Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />`
TreePath	WorkItemClassificationControl	WorkItemClassificationControl se utiliza para proporcionar una zona de control para un campo TreePath. `<Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />`

Atributos de campos de elementos de control opcionales para todos los tipos de control

Los siguientes atributos opcionales solo se pueden especificar para los tipos de control enumerados.

Atributo	Descripción
Field	Especifica el control que está asociado al campo de elemento de trabajo.
Label	Especifica el texto visible en el formulario que identifica el control. Escriba una cadena que no supere los 80 caracteres. Nota Puede adjuntar un hipervínculo a la etiqueta de un campo que se agrega al formulario de elemento de trabajo mediante FieldControl.Este control es útil para proporcionar un vínculo a información sobre el modo de usar el campo.Para obtener más información, vea Proporcionar texto de ayuda, hipervínculos o contenido web en un formulario de elemento de trabajo.
LabelPosition	Especifica la posición de la etiqueta relativa a los datos del control. Defina una cadena a partir de uno de los valores siguientes: Top, Bottom, Left y Right.
Dock	Especifica la alineación de la etiqueta con el lado indicado del contenedor o ajusta el campo de modo que rellene el contenedor. Especifica una cadena de uno de los siguientes valores: Fill, Top, Bottom, Left y Right.
Padding	Especifica, en píxeles, la cantidad de espacio alrededor del borde interior del control. Se proporcionan cuatro valores que corresponden a la parte superior, inferior, izquierda y derecha. Por ejemplo: (2,0,2,0).
Margin	Especifica, en píxeles, la cantidad de espacio alrededor del borde exterior del control. Se proporcionan cuatro valores que corresponden a la parte superior, inferior, izquierda y derecha. Por ejemplo: (2,0,2,0).
ReadOnly	Especifica si el campo es de sólo lectura. Indique True o False.
MinimumSize	Especifica el tamaño mínimo, en píxeles, que debe ocupar el control en el formulario. Se proporcionan dos valores que corresponden al ancho y alto. Por ejemplo: (100,100).
Name	Identifica un control de forma exclusiva. El atributo Name es obligatorio si hay varios controles en el formulario asociados al mismo campo de elemento de trabajo. Nota El atributo Name se usa para mostrar el mismo campo en más de un área en el 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.

Atributos de campos de elementos de control opcionales para tipos de control específicos

Los siguientes atributos opcionales solo se pueden especificar para los tipos de control enumerados.

Atributo	Tipos de control	Descripción
NumberFormat	FieldControl	Especifica los caracteres que se pueden escribir en el control de campo. Valores válidos: WholeNumbers, SignedWholeNumbers, DecimalNumbers y SignedDecimalNumbers.
MaxLength	FieldControl	Especifica la longitud máxima de caracteres que se puede utilizar para un control de campo.
Format	DateTimeControl	Especifica el formato del campo de fecha y hora que se corresponde con un valor de la enumeración DateTimePickerFormat. Valores válidos: Custom, Long, Short, Time.
CustomFormat	DateTimeControl	Especifica el formato personalizado que se utiliza en el campo de fecha y hora que corresponde a la sintaxis definida en la propiedad DateTimePicker.CustomFormat.

Agregar controles especiales

En la siguiente tabla se describen los atributos Control del elemento Type que proporcionan compatibilidad para poder administrar datos adjuntos de archivos, crear vínculos, mostrar contenido basado en web y ver otros datos que no están asociados a un campo de elemento de trabajo.

Atributo Type del elemento Control	Uso
AttachmentsControl	Se usa para adjuntar archivos a un formulario de elemento de trabajo. Este control normalmente se incluye en su propio grupo de pestañas, como se muestra en la siguiente ilustración. Control de datos adjuntos Para obtener más información, vea Agregar el control de datos adjuntos.
LabelControl	Se usa para mostrar texto sin formato o de hipervínculo que no está asociado a un campo, como se muestra en la siguiente ilustración. Los elementos secundario y contenedor LabelText y Link se usan para especificar el 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 Proporcionar texto de ayuda, hipervínculos o contenido web en un formulario de elemento de trabajo, Referencia de los elementos LabelText y Text de XML y Referencia de los elementos Link y Param de XML.
LinksControl	Se usa para crear y administrar vínculos entre elementos de trabajo. Este control normalmente se incluye en su propio grupo de pestañas, como se muestra en la siguiente ilustración. LinksControlOptions se usa para definir los filtros de 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 y Elementos LinksControlOptions.
StoryboardsControl	Se usa para abrir guiones gráficos de PowerPoint desde un elemento de trabajo y un vínculo a los archivos de guión gráfico guardados en un recurso compartido de red. Este control normalmente se incluye en su propio grupo de pestañas, como se muestra en la siguiente ilustración. Para agregar el StoryboardsControl a la sección FORM, agregue el siguiente fragmento de código: <Tab Label="Storyboards"> <Control Name="StoryboardsControl" Type="LinksControl"> <LinksControlOptions> <WorkItemLinkFilters FilterType="excludeAll" /> <ExternalLinkFilters FilterType="include"> <Filter LinkType="Storyboard" /> </ExternalLinkFilters> <LinkColumns> <LinkColumn RefName="System.Title" /> <LinkColumn LinkAttribute="System.Links.Comment" /> </LinkColumns> </LinksControlOptions> </Control> </Tab>
WebpageControl	Se utiliza para mostrar el contenido web en un formulario de elemento de trabajo. Este control se incluye normalmente en su propio grupo de pestañas. Utilice los elementos secundarios WebpageControlOptions y Link para especificar los controles necesarios para cargar el destino de la página web en el formulario de elemento de trabajo. Para obtener más información, vea Editar una definición WIT para agregar contenido web a un formulario de elemento de trabajo, Referencia de elementos XML WebpageControlOptions y Referencia de los elementos Link y Param de XML.

Agregar controles personalizados

Además de los controles integrados, puede agregar su propio control personalizado a un formulario de elemento de trabajo.

Por ejemplo, puede agregar un control personalizado para obtener una captura de pantalla del portapapeles. También puede proporcionar un control para capturar varios valores agregando una casilla para los valores que se presentan en una lista o un menú.

Para implementar un control personalizado, debe especificar el nombre del control en el atributo Type.