Control XML 元素引用

  • 项目

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

架构层次结构

WITD

   WORKITEMTYPE

       FORM

           布局

               Group

               列

               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" 
Padding="(top, bottom, left, right)" 
Margin="(top, bottom, left, right)" 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 字段类型的多行、格式文本格式的字段。

  • 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 网站：工作项跟踪自定义控件。

ControlFontSize

可选的 Control 特性。

指定字段名称或标签在窗体上的字号。 FontSize 的有效值：small、normal、large、xlarge 和 xxlarge。

EmptyText

可选的 Control 特性。

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

Label

可选的 Control 特性。

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

LabelFontSize

指定标签在窗体上的字号。 FontSize 的有效值：small、normal、large、xlarge 和 xxlarge。

LabelPosition

可选的 Control 特性。

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

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

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

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

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

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”指定为 Format 特性的值并使用自定义格式字符串设置另一个名为 CustomFormat 的特性来设置。 例如：

    Format="Custom"

    CustomFormat = "MMM dd, 'of the year' yyyy"

    有关详细信息，请参阅 Microsoft 网站：DateTimePicker.CustomFormat 属性。

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

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

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

有关详细信息，请参阅 Microsoft 网站：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

可选元素。

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

父元素

元素

描述

布局

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

Column 元素

必需。 定义窗体的列。

Tab 元素

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

备注

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

Layout 和 Column 指示器：

minOccurs =“0”

maxOccurs =“1”

Tab 指示器：

minOccurs =“0”

maxOccurs =“unbounded”

若要实现自定义控件，必须为 Type 特性指定控件名称。 有关详细信息，请参阅 Microsoft 网站：工作项跟踪自定义控件。

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

示例

<Control Type=" WorkItemClassificationControl " FieldName="System.AreaPath"
  Label="Area" LabelPosition="Left" Padding="(2,0,2,0)" Margin="(2,2,2,2)" />

元素信息

命名空间

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

架构名称

工作项类型定义

验证文件

WorkItemTypeDefinition.xsd

元素类型

ControlType 复杂类型

可为空

不适用

请参见

概念

设计和自定义工作项窗体 [重定向]

所有 FORM XML 元素引用

指定工作项窗体控件