指定工作项窗体控件

本主题中提供的信息可用作 Control 元素、子元素和特性的快速参考。 对于要在工作项窗体上显示的每个字段或窗体控件,都应添加一个 Control 元素。 您可自定义工作项窗体,以显示有助于您的团队正确使用该窗体的信息。 您可以添加工作项字段和控件,以便输入和查看要跟踪的数据。 Control 元素为 Type 特性提供了 9 个值,可以用于添加字段或者显示纯文本、超链接文本或字段。 此外,也可以定义特殊控件以添加链接和附件,显示基于 Web 的内容,或创建您自己的控件并将其添加到工作项窗体中。

主题内容

  • 将工作项字段添加到工作项窗体

  • 将特殊控件添加到工作项窗体

  • 将自定义控件添加到工作项窗体

将工作项字段添加到工作项窗体

自定义工作项窗体时,通常可添加为要在窗体上显示的工作项类型定义的工作项字段的子集。 字段定义控制与显示的数据或可向窗体中输入的数据有关的许多方面。 有关更多信息,请参见定义工作项字段

每个工作项字段都与一个数据类型相关联。 可用下表中的信息来确定 Control 元素的各个 Type 特性支持的字段类型。 使用 Label 特性指定要显示在控件旁边的文本。 使用相关的 LabelPosition 特性指定标签相对于控件的出现位置。 有关更多信息,请参见控制工作项字段的显示

备注

您不能更改系统字段的值,系统字段值是自动更新的。例如,“创建日期”和“创建者”字段在第一次保存工作项时进行定义。但是,可在搜索条件中使用这些字段。有关每个系统字段的说明,请参见工作项字段参考 (Visual Studio ALM)

字段类型

控件元素类型特性

用法

DateTime

FieldControl

DateTimeControl

使用 FieldControl 可为 DateTime 数据类型字段的输入或显示提供文本字段。

<Control FieldName=" MyCompany.Group1.StartDate " Type="FieldControl" Label="Start Date" LabelPosition="Left" />

使用 DateTimeControl 可提供日历选取器,以便为字段选择日期,如下图所示。

日历字段
<Control Type="DateTimeControl" FieldName="MyCompany.Group.ScheduleStart" Label="Scheduling Start Date:" LabelPosition="Left" Dock="Fill" Format="Short" />

Double

FieldControl

使用 FieldControl 可 Double 字段的输入或显示提供文本字段。

<Control FieldName="ABC_Company.Statistics.Analysis" Type="FieldControl" Label="Analysis %" LabelPosition="Left" />

History

WorkItemLogControl

使用 WorkItemLogControl 可为跟踪讨论线索和其他历史记录信息的 History 字段提供控件字段,如下图所示。

工作项窗体上的“历史记录”选项卡和字段

可以使用此控件仅支持显示工作项的历史记录字段,即 System.History 工作项字段。 使用此控件,您可以展开和折叠有关工作项的修订历史记录的详细信息。 也可以格式化添加到历史记录字段中的文本。

<Control Type="WorkItemLogControl" FieldName="System.History" Label="Detailed Description
and History" LabelPosition="Top" Dock="Fill" />

HTML

HTMLControl

使用 HTMLControl 可提供控件字段使 HTML 字段能够捕获 RTF 格式,如下图所示。

工作项窗体上显示的 HTML 字段
<Control Type="HtmlFieldControl" FieldName="Microsoft.VSTS.Notes" Label="Notes" Dock="Fill" />

Integer

FieldControl

使用 FieldControl 可为 Integer 字段提供控件字段。

<Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />

PlainText

FieldControl

使用 FieldControl 可为 PlainText 字段(例如,包含可能会大于 255 个字符的说明的文本框)提供控件字段。

<Control FieldName="Microsoft.VSTS.DocName" Type="FieldControl" Label="Vision Doc Location" LabelPosition="Left" />

String

FieldControl

使用 FieldControl 可为 String 字段提供控件字段。 String 字段限制为 255 个字符。

<Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />

TreePath

WorkItemClassificationControl

使用 WorkItemClassificationControl 可为 TreePath 字段提供控件字段。

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

ms194985.collapse_all(zh-cn,VS.110).gif所有控件类型的可选控件元素字段特性

只能为列出的控件类型指定以下可选特性。

特性

描述

Field

指定与工作项字段关联的控件。

Label

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

说明说明
使用 FieldControl 可将超链接附加到已添加到工作项窗体的字段的标签上。此控件可用于提供指向有关如何使用字段的信息的链接。有关更多信息,请参见在工作项窗体上提供帮助文本、过程指导、Web 内容和网页链接

LabelPosition

指定相对于控件数据的标签位置。 通过以下值之一指定字符串:Top、Bottom、Left 和 Right。

Dock

指定标签与容器的指定一侧对齐,或拉伸字段以填充容器。 通过以下值之一指定字符串:Fill、Top、Bottom、Left 和 Right。

Padding

指定控件内部边框四周的空间大小(以像素为单位)。 提供 4 个对应于顶部、底部、左侧和右侧的值。 例如:(2,0,2,0)。

Margin

指定控件外部边框四周的空间大小(以像素为单位)。 提供 4 个对应于顶部、底部、左侧和右侧的值。 例如:(2,0,2,0)。

ReadOnly

指定该字段为只读。 指定 True 或 False。

MinimumSize

指定控件在窗体中应占用的最小大小(以像素为单位)。 指定两个对应于宽度和高度的值。 例如:(100,100)。

Name

唯一地标识一个控件。 如果窗体上有多个控件与同一个工作项字段关联,则需要 Name 特性。

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

ms194985.collapse_all(zh-cn,VS.110).gif特定控件类型的可选控件元素字段特性

只能为列出的控件类型指定以下可选特性。

特性

控件类型

描述

NumberFormat

FieldControl

指定可以在字段控件中输入的字符。 下面的值有效:WholeNumbers、SignedWholeNumbers、DecimalNumbers 和 SignedDecimalNumbers。

MaxLength

FieldControl

指定可用于字段控件的最大字符长度。

Format

DateTimeControl

为日期-时间字段指定对应于 DateTimePickerFormat 枚举值之一的格式。 下面的值有效:Custom、Long、Short、Time。

CustomFormat

DateTimeControl

指定用于日期-时间字段的自定义格式,该格式对应于为 DateTimePicker.CustomFormat 属性定义的语法。

将特殊控件添加到工作项窗体

下表描述了 Control 元素的 Type 特性,这些特性提供支持,以便您可以管理文件的附件、创建链接、显示基于 Web 的内容以及查看不与工作项字段关联的其他数据。

控件元素类型特性

用法

AttachmentsControl

用于将文件附加到工作项窗体。 此控件通常包含在其自己的选项卡组中,如下图所示。

附件控件

附件控件的示例

有关更多信息,请参见添加附件控件

LabelControl

用于显示不与字段相关联的纯文本或超链接文本,如下图所示。

应用到文本的两个超链接的示例

使用 LabelText 和 Link 子元素和容器元素可指定文本、超链接以及其部分文本与超链接关联的字段或标签的位置。 有关更多信息,请参见在工作项窗体上提供帮助文本、过程指导、Web 内容和网页链接LabelText 和 Text XML 元素引用Link 和 Param XML 元素引用

LinksControl

用于创建和管理工作项之间的链接。 此控件通常包含在其自己的选项卡组中,如下图所示。

添加到工作项窗体的链接控件示例

使用 LinksControlOptions 可定义用于显示链接列表的链接筛选器和列字段布局。 有关更多信息,请参见定义链接控件以限制链接关系LinksControlOptions 元素

WebpageControl

用于在工作项窗体中显示 Web 内容。 此控件通常包含在其自己的选项卡组中。 使用 WebpageControlOptions 和 Link 子元素可指定在工作项窗体中加载网页目标所需的控件。

有关更多信息,请参见向工作项窗体添加 Web 内容WebpageControlOptions XML 元素引用Link 和 Param XML 元素引用

将自定义控件添加到工作项窗体

除了内置控件外,还可以向工作项窗体添加自己的自定义控件。

例如,可以添加用于从剪贴板捕获屏幕快照的自定义控件。 或者,可通过为列表或菜单中显示的值添加复选框,来提供用于捕获多个值的控件。

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

请参见

任务

添加和自定义工作项类型

更改工作项窗体布局

更改字段的标签

参考

Control XML 元素引用

概念

设计和自定义工作项窗体

其他资源

向工作项窗体添加 Web 内容