All Work Item FORM Elements

The following table describes all the permissible elements and attributes of the <FORM> section of a work item type definition.

Element

Attribute

Description

Required?

Schema Reference

FORM

 

Top-level form element

Yes

FORM Element (Work Item Type Definition Schema)

Layout

 

Defines a control

Yes

Layout Element (Work Item Type Definition Schema)

 

MinimumSize

String of the form width, height. This value specifies the minimum size for the form itself. When the container control is sized smaller than this size, horizontal and vertical scrollbars appear.

 

Layout Element (Work Item Type Definition Schema)

 

Target

String that specifies to which client this layout applies. The Visual Studio IDE renders this work item type in this layout if the Target attribute is omitted or set to WinForms. Third-party clients can specify additional layouts by using custom Target attributes that the IDE ignores.

No

Layout Element (Work Item Type Definition Schema)

 

Padding

String of the form (left, top, right, bottom) that specifies, in pixels, the amount of room you want around the outside border of the control and around the inside border. You can vary the amount of space on each side.

 

Layout Element (Work Item Type Definition Schema)

 

Margin

String of the form (left, top, right, bottom) that specifies the amount of room you want, in pixels, around the control and between the control and its neighbors. You can vary the amount of space on each side.

 

Layout Element (Work Item Type Definition Schema)

Column

 

Divides a form's regions into columns.

 

Column Element (Work Item Type Definition Schema)

 

PercentWidth

The width the column should occupy as a percentage of the width in the containing element. PercentWidth and FixedWidth are mutually exclusive.

No

Column Element (Work Item Type Definition Schema)

 

FixedWidth

The column width in pixels. PercentWidth and FixedWidth are mutually exclusive.

No

Column Element (Work Item Type Definition Schema)

Group

 

Provides visual grouping of elements, similar to the Windows GroupBox.

 

Group Element (Work Item Type Definition Schema)

 

Label

Label to be displayed in a group element.

No

Group Element (Work Item Type Definition Schema)

 

Padding

See description for Padding under Layout element.

 

Group Element (Work Item Type Definition Schema)

 

Margin

See description for Margin under Layout element.

 

Group Element (Work Item Type Definition Schema)

TabGroup

 

Hosts one or more tabs.

 

TabGroup Element (Work Item Type Definition Schema)

 

Padding

See description for Padding under Layout element.

 

TabGroup Element (Work Item Type Definition Schema)

 

Margin

See description for Margin under Layout element.

 

TabGroup Element (Work Item Type Definition Schema)

Tab

 

Defines one tab in a tab group.

 

Tab Element (Work Item Type Definition Schema)

 

Label

The label shown on the tab.

Yes

Tab Element (Work Item Type Definition Schema)

 

Padding

See description for Padding under Layout element.

 

Tab Element (Work Item Type Definition Schema)

 

Margin

See description for Margin under Layout element.

 

Tab Element (Work Item Type Definition Schema)

Control

 

Specifies a field that is to appear on the form.

 

Control Element (Work Item Type Definition Schema)

 

Name

Name for the control. If unspecified, the name is the same as the FieldName.

No

Control Element (Work Item Type Definition Schema)

 

Type

The type of the control.

Yes

Control Element (Work Item Type Definition Schema)

 

FieldName

The value of the FieldName property of the control.

No

Control Element (Work Item Type Definition Schema)

 

ID

Identifier for the field. Use of ID and Name are mutually exclusive.

No

Control Element (Work Item Type Definition Schema)

 

Label

Label for the field. If a label is specified, it overrides any label associated with the field in the metadata.

No

Control Element (Work Item Type Definition Schema)

 

LabelPosition

The label position relative to the field data. Possible values are as follows:

Top

Bottom

Left

Right

No

Control Element (Work Item Type Definition Schema)

 

Dock

If you specify it, the Dock property stretches a field to fill the rest of the container. Valid field docking values are as follows:

Fill

Top

Bottom

Left

Right

No

Control Element (Work Item Type Definition Schema)

 

Padding

See description for Padding under Layout element.

 

Control Element (Work Item Type Definition Schema)

 

Margin

See description for Margin under Layout element.

 

Control Element (Work Item Type Definition Schema)

 

ReadOnly

If you specify it, you can display a read-only field in a control. Different controls respond in slightly different ways to this attribute.

No

Control Element (Work Item Type Definition Schema)

Splitter

 

Positions a splitter with the designed orientation on the form between two sibling form elements.

 

Splitter Element (Work Item Type Definition Schema)

 

Dock

The orientation and docking behavior for the splitter. Valid values are as follows:

Fill

Top

Bottom

Left

Right

Yes

Splitter Element (Work Item Type Definition Schema)

See Also

Concepts

Work Item Form Sample

Other Resources

Work Item Type Definition Schema