Control XML 元素引用

  • 项目

使用 Control 元素可定义要在工作项窗体中显示的工作项字段、文本、超链接或其他控件元素。有关如何使用此元素的示例，请参见指定工作项窗体控件。有关更多信息，请参见设计和自定义工作项窗体。

架构层次结构

WITD

   WORKITEMTYPE

       FORM

           布局

               组

               列

               Tab

<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" 
Dock="Fill | Top | Bottom | Left | Right" Padding="(left, top, right, bottom)" 
Margin="(left, top, right, bottom)" ReadOnly="True | False" MinimumSize="(width,height)" 
Name="InstanceName" >
<LabelText> . . . </LabelText>
<Link> . . . </Link>
<LinksControlOptions> . . . </LinksControlOptions>
<WebpageControlOptions> . . . </WebpageControlOptions>
</Control>

特性和元素

以下几节描述了特性、子元素和父元素。

特性

特性

说明

FieldName

可选的 Control 特性。

指定与控件关联的工作项字段。特性类型为 typelib:ReferenceFieldName。最小长度：1；最大长度：70。

模式值：^[a-zA-Z_][a-zA-Z0-9_]*(\.[a-zA-Z0-9_]+)+$

模式值示例：公司.部门.问题类型

Type

必选的 Control 特性。

指定控件的数据类型。特性类型为 ValidControlsType 简单类型。通过以下内置类型之一指定字符串：

  • AttachmentControl：用于显示工作项附件。此控件不具有关联的字段或字段类型。

  • DateTimeControl：用于显示具有 DateTime 字段类型的格式化的日期字段。

  • FieldControl：用于显示具有 String、Identity、Integer、Double 和 PlainText 字段类型的纯文本或数字字段以及字段的值列表。

  • HtmlFieldControl：用于显示具有 HTML 字段类型的多行及 RTF 格式的字段。

  • LabelControl：用于显示不与字段相关联的文本。文本可以是纯文本或超链接。您可以指定其他控件使用LabelText， Link和Text元素。请参见LabelText 和 Text XML 元素引用和Link 和 Param XML 元素引用。

  • LinksControl： 用于显示链接控件工具栏和管理工作项和情节串联板之间的链接关系。此控件不具有关联的字段或字段类型。您指定的筛选器和其他选项使用的链接类型LinksControlOptions元素。请参见 LinksControlOptions 元素。

  • WebpageControl：用于显示由 URI 定义或嵌入到 CDATA 标记中的基于 HTML 的内容。此控件不具有关联的字段或字段类型。.您指定的内容和链接以显示使用WebpageControlOptions元素。请参见 WebpageControlOptions XML 元素引用。

  • WorkItemClassificationControl 用于显示具有 TreePath 字段类型的分层路径字段。

    说明说明
    只有 System.AreaPath 和 System.IterationPath 字段使用此数据类型。不能使用此数据类型定义自定义字段。

  • WorkItemLogControl：用于显示工作项历史记录信息以及具有 History 字段类型的字段。

    说明说明
    System.History 字段是使用此数据类型的唯一字段。不能使用此数据类型定义自定义字段。

有关更多信息，请参见 指定工作项窗体控件。

说明说明
可以通过将 Type 特性设置为自定义值来使用自定义控件。任何 Type 值与内置类型的名称不匹配的控件都被视为自定义控件。有关更多信息，请参见以下 Microsoft 网站：Work Item Tracking Custom Controls（工作项跟踪自定义控件）。

ControlFontSize

可选的 Control 特性。

在窗体上指定的字段名称或标签的字体大小。Valid values of FontSize: small, normal, large, xlarge, and xxlarge.

EmptyText

可选的 Control 特性。

指定当字段为空时显示的长度在 1 和 255 个字符之间的文本字符串。

Label

可选的 Control 特性。

指定窗体上标识控件的可见文本。指定一个不超过 80 个字符的字符串。

LabelFontSize

在窗体上指定标签的字体大小。Valid values for FontSize: small, normal, large, xlarge, and xxlarge.

LabelPosition

可选的 Control 特性。

指定相对于控件数据的标签位置。通过以下值之一指定字符串：

  • Top：将标签置于控件数据之上。

  • Bottom：将标签置于控件数据之下。

  • Left：将标签置于控件数据的左侧。

  • Right：将标签置于控件数据的右侧。

Dock

可选的 Control 特性。

将字段与容器的指定一侧对齐，或拉伸字段以填充容器。特性类型为 DockType。通过以下值之一指定字符串：

  • Fill：对齐字段，使它填满容器。该值不是 Splitter 元素的受支持方向。

  • Top：将字段与容器顶部对齐。该值不是 Splitter 元素的受支持方向。

  • Bottom：将字段与容器底部对齐。该值不是 Splitter 元素的受支持方向。

  • Left：将字段与容器的左侧对齐。

  • Right：将字段与容器的右侧对齐。该值不是 Splitter 元素的受支持方向。

Padding

可选的 Control 特性。

指定控件内边框附近像素的空间量，其对应于上、下、左和右空间。特性类型为 SizeType。

模式值：^\(\d+\,\d+\,\d+\,\d+\)$

模式值示例：(2,0,2,0)

Margin

可选的 Control 特性。

指定控件外边框附近像素的空间量，其对应于上、下、左和右空间。特性类型为 SizeType。

模式值：^\(\d+\,\d+\,\d+\,\d+\)$

模式值示例：(2,0,2,0)

ReadOnly

可选的 Control 特性。

指定该字段为只读。特性类型为 ReadOnlyType。通过以下值之一指定字符串：

  • True：指定控件数据为只读。

  • False：指定控件数据非只读。

MinimumSize

可选的 Control 特性。

指定控件在窗体中应占用的最小大小（以像素为单位）。语法在 width,height 中指定。特性类型为 SizeType。

模式值：^\(\d+\,\d+\)$

模式值示例：(100,100)

说明说明
如果没有足够的垂直空间，则之后将出现滚动条以保持其最小大小。如果没有此特性，控件会按默认大小绘制，除非其他选项卡中的控件需要更多空间。任何一个窗体控件的总体大小取决于最大的窗体区域或选项卡的大小。

Name

可选的 Control 特性。

唯一地标识一个控件。如果窗体上有多个控件与同一个工作项字段关联，则 Name 是很重要的。特性类型为 xs:string。

说明说明
当希望在窗体的多个位置显示相同字段时，可使用 Name 特性。您可以为两个控件项的 Name 特性分别指定唯一值，以便系统唯一地标识每个控件。基于选项卡上下文在各种位置显示相同的控件，这非常有用。

NumberFormat

可选的 Control 特性，该特性仅在用于 FieldControl 特性时有效。

指定可以在字段控件中输入的字符。可以使用的有效值如下：

  • WholeNumbers：指定允许整数。

  • SignedWholeNumbers：指定允许有符号的整数。

  • DecimalNumbers：指定允许十进制数字。

  • SignedDecimalNumbers：指定允许有符号的十进制数字。

MaxLength

可选的 Control 特性，该特性仅在用于 FieldControl 特性时有效。

指定可用于字段控件的最大字符长度。特性类型为 xs:integer。

Format

可选的 Control 特性，该特性仅在用于 DateTimeControl 特性时有效。

为日期-时间字段指定对应于 DateTimePickerFormat 枚举值之一的格式。可以使用的有效值如下：

  • Custom：以自定义格式显示日期/时间值。通过指定“Custom”为格式特性值可以设置自定义格式，并以自定义格式字符串设置名为 CustomFormat 的另一特性。例如：

    Format="Custom"

    CustomFormat =“MMM dd，yyyy”

    有关更多信息，请参见 Microsoft 网站：DateTimePicker.CustomFormat 属性。

  • Long：以用户操作系统设置的长日期格式显示日期/时间值。

  • Short：以用户操作系统设置的短日期格式显示日期/时间值。

  • Time：以用户操作系统设置的时间格式显示日期/时间值。

有关更多信息，请参见 Microsoft 网站：DateTimePickerFormat Enumeration（DateTimePickerFormat 枚举）。

CustomFormat

可选的 Control 特性，该特性仅在用于 DateTimeControl 和 Format 特性时有效。

指定用于日期-时间字段的自定义格式，该格式对应于为 DateTimePicker.CustomFormat 属性定义的语法。有关更多信息，请参见 Microsoft 网站：DateTimePicker.CustomFormat 属性。

子元素

元素

说明

LabelText

可选元素。您可以指定此元素时Type属性被指定为FieldControl或LabelControl。

用于指定文本、超链接以及在文本方面与超链接部分关联的字段或标签的位置的容器元素。

有关更多信息，请参见LabelText 和 Text XML 元素引用和 在工作项窗体上提供帮助文本、过程指导、Web 内容和网页链接。

Link

可选元素。您可以指定此元素时Type属性被指定为FieldControl或LabelControl。

为字段或标签定义超链接。

有关更多信息，请参见Link 和 Param XML 元素引用和 在工作项窗体上提供帮助文本、过程指导、Web 内容和网页链接。

LinksControlOptions

可选元素。您可以指定此元素时Type属性被指定为LinksControl。

对用于显示链接列表的链接筛选器和列字段布局进行定义。

有关更多信息，请参见定义链接控件以限制链接关系。

WebpageControlOptions

可选元素。您可以指定此元素时Type属性是WebpageControl。

指定在工作项窗体中控制网页目标加载的控件。

有关更多信息，请参见WebpageControlOptions XML 元素引用和 在工作项窗体上提供帮助文本、过程指导、Web 内容和网页链接。

anyAttribute

可选元素。

可选。可以通过使用 anyAttribute 元素来扩展 Control。

父元素

元素

说明

布局

必选。指定如何在工作项窗体上显示元素。

列元素

必选。定义窗体的列。

选项卡元素

必选。定义窗体的选项卡。

备注

Control 是 Layout、Column 和 Tab 的可选子元素。

Layout 和 Column 指示符：

minOccurs = "0"

maxOccurs = "1"

Tab 指示符：

minOccurs = "0"

maxOccurs = "unbounded"

若要实现自定义控件，必须为 Type 特性指定控件名称。有关更多信息，请参见以下 Microsoft 网站：Work Item Tracking Custom Controls（工作项跟踪自定义控件）。

有关各控件类型的示例，请参见指定工作项窗体控件。

示例

<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
  Label="Area" LabelPosition="Left" />

元素信息

命名空间

https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef

架构名称

工作项类型定义

验证文件

WorkItemTypeDefinition.xsd

元素类型

ControlType 复杂类型

是否可以为空

不适用

请参见

概念

设计和自定义工作项窗体

所有 FORM XML 元素参考

指定工作项窗体控件