Compartir a través de

Referencia de todos los elementos FORM de XML

  • Artículo

Puede usar la información que se proporciona en este tema como una referencia rápida de los elementos y los principales atributos que controlan el formulario de un tipo de elemento de trabajo. Estos elementos se especifican en el contenedor de elemento FORM, la tercera y última sección principal de la definición de un tipo de elemento de trabajo. Muchos elementos están anidados dentro de otros para formar grupos, secciones o pestañas en un formulario de elemento de trabajo. Para obtener más información sobre cómo se agrupan estos elementos, vea Diseñar el formulario de elemento de trabajo.

En este tema

  • Ejemplo de FORM

  • Sintaxis de los elementos FORM

  • Atributos que los elementos FORM especifican

  • Elementos que especifican etiquetas independientes, hipervínculos, páginas web o contenido HTML

  • Elementos que filtran y presentan relaciones de vínculo

Ejemplo de FORM

En el siguiente ejemplo se muestra la estructura general del elemento FORM. Para especificar el diseño de un formulario se usa el elemento Layout. Puede especificar diseños diferentes para distintos destinos cliente. Por ejemplo, puede especificar un diseño para los clientes de Windows y otro para Team Web Access. Normalmente un diseño está compuesto de la parte superior del formulario y de un grupo de pestañas. La secuencia en la que define los elementos dentro del diseño determina la secuencia en la que los elementos aparecen en el formulario.

Los elementos se agrupan para aparecer dentro de las columnas utilizando elementos Group y Column. Un elemento Control se usa para definir cada campo que desea que aparezca en el formulario. El elemento Tab se usa para admitir áreas funcionales diferentes de grupos de campos.

<FORM>
      <Layout>
        <Group>
          <Column PercentWidth="70">
            <Group>
              <Column PercentWidth="100">
                <Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />
                <Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />
                <Control FieldName="System.IterationPath" Type="WorkItemClassificationControl" Label="&amp;Iteration Path:" LabelPosition="Left" />
                <Group>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.ProductUnit" Type="FieldControl" Label="PU (Use Area Path)" LabelPosition="Left" />
                  </Column>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.Priority" Type="FieldControl" Label="Priority" LabelPosition="Left" />
                  </Column>
                </Group>
              </Column>
            </Group>
          </Column>
          <Column PercentWidth="30">
            <Group Label="Status">
              <Column PercentWidth="100">
                <Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />
                <Control FieldName="System.State" Type="FieldControl" Label="State" LabelPosition="Left" />
                <Control FieldName="System.AssignedTo" Type="FieldControl" Label="Assigned To" LabelPosition="Left" />
              </Column>
            </Group>
          </Column>
        </Group>

. . .
</Layout>
</FORM>

Elementos de formulario

Puede especificar cómo se agrupan la información y los campos de elemento de trabajo y cómo aparecen en un formulario de elemento de trabajo si utiliza los elementos que se describen en la siguiente tabla.

Nota

Para obtener los mejores resultados, debe anidar los elementos Control en Group y los elementos Group en Column, incluso si la columna abarca el ancho completo del formulario.Asimismo, debe anidar cada sección Column en Group, aunque el grupo no tenga ninguna etiqueta ni límite visible.

Elemento

Descripción

¿Obligatorio?

Column

Divide las áreas de un formulario en columnas.

<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Column >

Se recomienda

Control

Define un campo, texto, hipervínculo u otro elemento de control que aparecerá en el formulario de elemento de trabajo.

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

Para obtener más información, vea el tema sobre el Referencia del elemento Control de XML.

Requerido

FORM

Define el elemento de formulario de nivel superior.

<FORM>
   <Layout> . . . </Layout>
</FORM>

Requerido

Group

Proporciona una agrupación visual de los elementos, de forma similar a Windows GroupBox.

<Group Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Column> . . . </Column>
</Group >

Se recomienda

Layout

Define el diseño del formulario de elemento de trabajo.

<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(top, bottom, left, right)" 
Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance">
   <Group> . . . </Group>
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Layout>

Requerido

Splitter

Divide un formulario en dos áreas para admitir el diseño de dos elementos de formulario relacionados.

Splitter />

Opcional

Tab

Define el diseño de una pestaña única en un grupo de pestañas.

<Tab Label="LabelText" Padding="(top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Group> . . . </Group
   <Control> . . . </Control>
   <TabGroup> . . . </TabGroup>
   <Splitter> . . . </Splitter>
</Tab>

Opcional

TabGroup

Define una o más pestañas para el formulario.

<TabGroup Padding="( top, bottom, left, right)" Margin="(top, bottom, left, right)">
   <Tab> . . . </Tab>
</TabGroup>

Opcional

Atributos utilizados para dar formato a los elementos FORM

Puede controlar el espaciado y tamaño de muchos elementos de un formulario de elemento de trabajo si especifica los atributos descritos en la tabla siguiente. Para obtener más información, vea Diseñar el formulario de elemento de trabajo.

Atributo

Descripción

Elementos aplicables

ControlSpacing

Opcional. Especifica el desplazamiento vertical de los controles. Integer.

Layout

FixedWidth

Opcional. Ancho de la columna en píxeles. PercentWidth y FixedWidth se excluyen mutuamente.

Column

Label

Opcional. Texto que aparecerá para un control o grupo. Si se especifica una etiqueta, invalida cualquier otra etiqueta asociada al campo en los metadatos para el control.

Requerido para el elemento Tab. Texto que aparecerá para una pestaña.

LabelText es una cadena de texto que contiene entre 1 y 80 caracteres.

Control

Group

Tab

LabelPosition

Opcional. Posición de la etiqueta en relación con los datos de campo. Los valores posibles son Superior, Inferior, Izquierda y Derecha.

Control

LabelSpacing

Opcional. Especifica el número de píxeles entre la etiqueta y el área de edición del control.

Layout

Margin

Opcional. Cadena con el formato (izquierda, superior, derecha, inferior) que especifica, en píxeles, la cantidad de espacio alrededor del control y entre el control y sus vecinos. Se puede variar la cantidad de espacio en cada lado.

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

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

Control

Group

Layout

Tab

TabGroup

MinimumSize

Opcional. Cadena con el formato (ancho, alto). Este valor especifica el tamaño mínimo para el propio formulario. Cuando el tamaño del control contenedor es menor que este tamaño, aparecen barras de desplazamiento horizontal y vertical.

Control

Layout

Name

Opcional. Nombre del control. Si no se especifica, el nombre es igual a FieldName.

Control

Padding

Opcional. Cadena con el formato (superior, inferior, izquierda, derecha) que especifica, en píxeles, la cantidad de espacio alrededor del borde exterior del control y alrededor del borde interior. Se puede variar la cantidad de espacio en cada lado.

Control

Group

Layout

Tab

TabGroup

PercentWidth

Opcional. Ancho de columna como un porcentaje del ancho del elemento contenedor. PercentWidth y FixedWidth se excluyen mutuamente.

Column

ReadOnly

Opcional. Puede mostrar un campo de solo lectura en un control. Los distintos controles responden de forma ligeramente diferente a este atributo.

Control

Target

Opcional. Cadena que especifica a qué cliente se aplica este diseño. Visual Studio muestra este tipo de elemento de trabajo en este formato si se omite el atributo Target o se establece en Windows Forms. Los clientes externos pueden especificar diseños adicionales mediante atributos Target personalizados que Visual Studio omite.

Valores válidos son:

  • WinForms: aplica el formulario a Team Explorer y Team Explorer Everywhere.

  • Web: aplica el formulario a Team Web Access.

Layout

Type

Requerido. Tipo del control. Para obtener más información, vea el tema sobre el Referencia del elemento Control de XML.

Control

Elementos que especifican etiquetas independientes, hipervínculos, páginas web o contenido HTML

El elemento WebpageControlOptions y sus elementos secundarios tienen la siguiente estructura de sintaxis:

<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
   <Link UrlRoot="UrlRoot" UrlPath ="UrlPathWithParameters">
      <Param index="IndexValue" value="ParamValue" type ="Original | Current"/>
   </Link>
   <Content>
      <![CDATA[Contents of HTML]]>
   </Content>
</WebpageControlOptions>

Los elementos que se describen en la siguiente tabla se usan para definir el texto sin formato o las etiquetas hipervinculadas, agregar los hipervínculos a un campo o mostrar el contenido de una página web en un formulario de elemento de trabajo. Para obtener más información, vea Proporcionar texto de ayuda, hipervínculos o contenido web en un formulario de elemento de trabajo.

Elemento

¿Obligatorio?

Descripción

Content

Elemento WebpageControlOptions opcional.

Especifica que el contenido de CDATA basado en HTML aparezca en un formulario de elemento de trabajo.

<Content>
   <![CDATA[Contents of HTML]]>
</Content>

Para obtener más información, vea Referencia de elementos XML WebpageControlOptions.

LabelText

Elemento Control opcional cuando type="LabelControl".

Define una etiqueta sin formato o hipervinculada.

Para obtener más información, vea Referencia de los elementos LabelText y Text de XML.

Link

Elemento Control opcional cuando type="FieldControl".

Elemento Text opcional.

Elemento WebpageControl opcional.

Elemento WebpageControlOptions opcional.

Define el hipervínculo para que un campo, etiqueta o contenido del explorador web aparezca en un formulario de elemento de trabajo.

<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
   <Param />
</Link>

Para obtener más información, vea Referencia de los elementos Link y Param de XML.

Param

Elemento Link opcional.

Especifica un valor para determinar la dirección URL del hipervínculo cuando se especifica URLPath para el elemento Link.

<Param index="IndexValue " value="ParamValue " type ="Original | Current"/>

Para obtener más información, vea Referencia de los elementos Link y Param de XML.

Text

Elemento LabelText opcional.

Elemento contenedor para la información o etiqueta que aparecerá en el formulario de elemento de trabajo.

<Text>
   <Link >
      <Param />
   </Link>
   LabelText
</Text>

Para obtener más información, vea Referencia de los elementos LabelText y Text de XML.

WebpageControlOptions

Elemento Control opcional cuando type="WebpageControl"

Elemento contenedor que especifica las opciones para el control de página web.

Para obtener más información, vea Referencia de elementos XML WebpageControlOptions.

Elementos que filtran y presentan relaciones de vínculo

El elemento LinksControlOptions se usa para definir las opciones que controlan los vínculos que se pueden agregar a un elemento de trabajo y las columnas predeterminadas que desea que aparezcan para la lista de vínculos en un elemento de trabajo. Al agregar el control de vínculo a un formulario de elemento de trabajo, puede especificar filtros que restringen los tipos de vínculos que los usuarios pueden crear y los tipos de elemento de trabajo entre los que los usuarios pueden crear los vínculos. El elemento LinksControlOptions y sus elementos secundarios tienen la siguiente estructura:

<LinksControlOptions>
   <WorkItemLinkFilters FilterType="include | exclude | includeAll | excludeAll">
       <Filter LinkType="linkTypeRefName" FilterOn="reverseName | forwardName" />
   </WorkItemLinkFilters>
   <ExternalLinkFilters FilterType ="include | exclude | includeAll | excludeAll">
       <Filter LinkType="externalLinkName"/>
   </ExternalLinkFilters>
   <WorkItemTypeFilters Scope=" project | all" FilterType=" include | exclude | includeAll" />
       <Filter WorkItemType="workItemTypeReferenceName"/>
   </WorkItemTypeFilters>
   <LinkColumns>
      <LinkColumn RefName="referenceName" | LinkAttribute="linkAttributeName"/>
   </LinkColumns>
</LinksControlOptions>

Específicamente, puede usar los elementos que se resumen en la tabla siguiente. Para obtener más información sobre cómo usar estos elementos, vea Definir controles de vínculos para restringir las relaciones de los vínculos y Elementos LinksControlOptions.

Elemento

¿Obligatorio?

Descripción

LinksControlOptions

Elemento Control opcional cuando type="LinksControl"

Proporciona un contenedor para los elementos que definen las opciones que controlan los vínculos que se pueden agregar a un elemento de trabajo y las columnas predeterminadas que desea que aparezcan para la lista de vínculos en un elemento de trabajo.

WorkItemLinkFilters

Elemento LinksControlOptions opcional

Proporciona un contenedor para uno o más elementos Filter que especifican los criterios de filtro del vínculo que se van a usar para los tipos de vínculo definidos para la colección de proyectos de equipo.

ExternalLinkFilters

Elemento LinksControlOptions opcional

Proporciona un contenedor para uno o más elementos Filter que especifican los criterios de filtro que se van a usar para los tipos de vínculo definidos en otros proyectos de equipo.

WorkItemTypeFilters

Elemento LinksControlOptions opcional

Proporciona un contenedor para uno o más elementos Filter que especifican los criterios de filtro que se van a aplicar a los tipos de elemento de trabajo.

Filter (tipos de vínculo)

Elemento WorkItemLinkFilters obligatorio cuando el atributo FilterType es exclude o include.

Elemento ExternalLinkFilters obligatorio cuando el atributo FilterType es exclude o include.

Especifica los tipos de vínculos que se van a incluir o excluir del conjunto de vínculos que se pueden crear para el elemento de trabajo.

Filter (tipos de elemento de trabajo)

Elemento WorkItemTypeFilters opcional cuando el atributo FilterType es exclude o include.

Especifica los tipos de elemento de trabajo que se van a incluir o excluir del conjunto de tipos de elemento de trabajo entre los que los usuarios pueden vincular.

LinkColumns

Elemento LinksControlOptions opcional

Proporciona un contenedor para una o más etiquetas LinkColumn.

LinkColumn

Elemento LinkColumns obligatorio

Especifica los campos de elemento de trabajo y atributos de tipo de vínculo que van a aparecer en el formulario de elemento de trabajo para la lista de vínculos.

Vea también

Conceptos

Diseñar el formulario de elemento de trabajo

Otros recursos

Seguimiento de elementos de trabajo: Índice de definiciones de elementos XML