ControlType Complex Type (Work Item Type Definition Schema)
Defines a control that is to appear on the work item form.
<xs:complexType name="ControlType">
<xs:attribute name="FieldName" type="typelib:ReferenceFieldName" use="optional" />
<xs:attribute name="Type" type="ValidControlsType" use="required" />
<xs:attribute name="Label" type="LabelType" use="optional" />
<xs:attribute name="LabelPosition" type="LabelPositionType" />
<xs:attribute name="Dock" type="DockType" use="optional" />
<xs:attribute name="Padding" type="PaddingType" use="optional" />
<xs:attribute name="Margin" type="PaddingType" use="optional" />
<xs:attribute name="ReadOnly" type="ReadOnlyType" use="optional" />
<xs:attribute name="MinimumSize" type="SizeType" use="optional" />
<xs:attribute name="Name" type="xs:string" use="optional" />
<xs:anyAttribute processContents="skip"/>
</xs:complexType>
Attributes and Elements
The following sections describe attributes, child elements, and parent elements.
Attributes
Attribute |
Description |
|---|---|
FieldName |
Optional attribute. Specifies the work item field with which the control is associated. The attribute type is typelib:ReferenceFieldName. Minimum length: 1; maximum length: 70. Pattern value: ^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_])+$ Pattern value example: Company.Division.IssueType |
Type |
Required attribute. Specifies the data type of the control. The attribute type is ValidControlsType Simple Type (Work Item Type Definition Schema). For more information, see Specifying Work Item Form Controls. |
Label |
Optional attribute. Specifies the visible text on the form that identifies the control. The attribute type is LabelType Simple Type (Work Item Type Definition Schema). Maximum length: 80. |
LabelPosition |
Optional attribute. Specifies the position of the label relative to the control data. The attribute type is LabelPositionType Simple Type (Work Item Type Definition Schema). |
Dock |
Optional attribute. Aligns the field with the specified side of the container, or stretches the field to fill the container. The attribute type is DockType Simple Type (Work Item Type Definition Schema). |
Padding |
Optional attribute. Specifies the amount of space in pixels around the inside border of the control. The attribute type is PaddingType Simple Type (Work Item Type Definition Schema). Pattern value: ^\(\d+\,\d+\,\d+\,\d+\)$ Pattern value example: (2,0,2,0) |
Margin |
Optional attribute. Specifies the amount of space in pixels around the outside border of the control. The attribute type is PaddingType Simple Type (Work Item Type Definition Schema). Pattern value: ^\(\d+\,\d+\,\d+\,\d+\)$ Pattern value example: (2,0,2,0) |
ReadOnly |
Optional attribute. Specifies that the control data is read-only. The attribute type is ReadOnlyType Simple Type (Work Item Type Definition Schema). |
MinimumSize |
Optional attribute. Specifies the minimum size in pixels that the control can be. The attribute type is SizeType Simple Type (Work Item Type Definition Schema). Pattern value: ^\(\d+\,\d+\)$ Pattern value example: (100,100) |
Name |
Optional attribute. Identifies a control uniquely. Name is essential if more than one control on the form is associated with the same work item field. The type is xs:string. |
Child Elements
Element |
Description |
|---|---|
anyAttribute |
Optional element. ControlType is extensible through use of the anyAttribute element. ProcessContents: skip. |
Parent Elements
None
Remarks
ControlType is the Control Element (Work Item Type Definition Schema) type.
Element Information
Namespace |
https://schemas.microsoft.com/VisualStudio/2005/workitemtracking/typedef |
Schema Name |
Work Item Type Definition |
Validation File |
WorkItemTypeDefinition.xsd |
Can be Empty |
Not applicable |