共用方式為

Control XML 項目參考

  • 發行項

更新：2011 年 1 月

您可以使用 Control 項目來定義顯示在工作項目表單中的工作項目欄位、 文字、 超連結或其他控制項目。 如需如何使用這個項目的範例，請參閱指定工作項目表單控制項。 如需詳細資訊，請參閱設計和自訂工作項目表單。

結構描述階層架構

WITD

   WORKITEMTYPE

       FORM

           Layout

               Group

               Column

               Tab

<xs:element name="Control" type="ControlType" minOccurs="0"/>

<Control FieldName="FieldName" Type="AttachmentsControl | DateTimeControl | FieldControl | 
HtmlFieldControl | LabelControl | LinksControl | WebpageControl | WorkItemClassificationControl | 
WorkItemLogControl" 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

選擇性 ControlType 屬性。

指定與控制項相關聯的工作項目欄位。 屬性型別為 typelib:ReferenceFieldName。 最小長度：1；最大長度：70。

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

模式值範例：Company.Division.IssueType

Type

必要的 ControlType 屬性。

指定控制項的資料型別。 屬性型別為 ValidControlsType 簡單型別。 指定具有下列一個內建型別的字串：

  • AttachmentControl：用來顯示工作項目附件。 此控制項沒有相關聯的欄位或欄位型別。

  • DateTimeControl：用來顯示格式化的日期欄位，具有 DateTime 的欄位型別。

  • FieldControl：用來顯示純文字或數值欄位，並以 String、Identity、Integer、Double 和 PlainText 的欄位型別列出欄位的值。

  • HtmlFieldControl：用來顯示多行、RTF 格式的欄位，具有 HTML 的欄位型別。

  • LabelControl：用來顯示未與欄位相關聯的文字。 文字可以是純文字或超連結文字。

  • LinksControl：用來顯示工作項目連結。 此控制項沒有相關聯的欄位或欄位型別。

  • WebpageControl：用來顯示 HTML 架構的內容，該內容由 URI 定義，或是內嵌在 CDATA 標記內。 此控制項沒有相關聯的欄位或欄位型別。

  • WorkItemClassificationControl 可用來顯示階層式路徑欄位，該欄位具有 TreePath 的欄位型別。

    注意事項注意事項
    System.AreaPath 和 System.IterationPath 欄位是唯一使用這個資料型別的欄位。您無法使用這個資料型別來定義自訂欄位。

  • WorkItemLogControl：用來顯示工作項目歷程記錄資訊，以及具有 History 之欄位型別的欄位。

    注意事項注意事項
    System.History 欄位是唯一使用此資料型別的欄位。您無法使用這個資料型別來定義自訂欄位。

如需詳細資訊，請參閱指定工作項目表單控制項。

注意事項注意事項
藉由將 Type 屬性設定為某個自訂值，即可使用自訂控制項。任何具有 Type 值的控制項，只要其與內建類型的名稱不相符，即可視為自訂控制項。如需詳細資訊，請參閱 Microsoft 網站：工作項目追蹤自訂控制項 (英文)。

Label

選擇性 ControlType 屬性。

指定表單上可識別控制項的可見文字。 指定長度不超過 80 個字元的字串。

LabelPosition

選擇性 ControlType 屬性。

指定標籤相對於控制項資料的位置。 指定具有下列一個值的字串：

  • Top：將標籤放置在控制項資料的上方。

  • Bottom：將標籤放置在控制項資料的下方。

  • Left：將標籤放置在控制項資料的左側。

  • Right：將標籤放置在控制項資料的右側。

Dock

選擇性 ControlType 屬性。

將欄位與容器指定的一邊一起對齊，或讓欄位延伸以填滿容器。 屬性型別為 DockType。 指定具有下列一個值的字串：

  • Fill：對齊欄位使容器填滿。 這個值不是 Splitter 項目支援的方向。

  • Top：將欄位與容器的頂端一起對齊。 這個值不是 Splitter 項目支援的方向。

  • Bottom：將欄位與容器的底部一起對齊。 這個值不是 Splitter 項目支援的方向。

  • Left：將欄位與容器的左邊一起對齊。

  • Right：將欄位與容器的右邊一起對齊。 這個值不是 Splitter 項目支援的方向。

Padding

選擇性 ControlType 屬性。

以像素為單位，指定控制項內部框線周圍的空間量，該值對應於頂端、底部、左邊與右邊的空間。 屬性型別為 SizeType。

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

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

Margin

選擇性 ControlType 屬性。

以像素為單位，指定控制項外部框線周圍的空間量，該值對應於頂端、底部、左邊與右邊的空間。 屬性型別為 SizeType。

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

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

ReadOnly

選擇性 ControlType 屬性。

指定欄位是唯讀的。 屬性型別為 ReadOnlyType。 指定具有下列一個值的字串：

  • True：指定控制項資料是唯讀的。

  • False：指定控制項資料不是唯讀的。

MinimumSize

選擇性 ControlType 屬性。

指定控制項在表單中應佔據的大小下限 (以像素為單位)。 語法在 (width,height) 中指定。 屬性型別為 SizeType。

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

模式值範例：(100,100)

注意事項注意事項
如果您沒有足夠的垂直空間，捲軸就會出現以維持其最小的大小。若沒有這個屬性，除非其他索引標籤中的控制項使用較多空間，否則會以控制項的預設大小加以繪製。任何一個表單控制項的整體的大小取決於最大表單區域或索引標籤的大小。

Name

選擇性 ControlType 屬性。

唯一地識別控制項。 如果表單上有超過一個控制項與相同工作項目欄位相關聯，Name 就非常重要。 屬性型別為 xs:string。

注意事項注意事項
當您想在表單中的多個位置顯示同一個欄位時，請使用 Name 屬性。您可對兩個控制項目指定唯一的 Name 值，以便系統唯一地識別每個控制項。根據索引標籤的內容在各種位置顯示相同的控制項時，這個屬性很有用。

NumberFormat

選擇性的 ControlType 屬性，只有在搭配 FieldControl 使用時才會有效。

指定您可以在欄位控制項中輸入的字元。 您可以使用的有效值如下所示：

  • WholeNumbers：指定允許整數。

  • SignedWholeNumbers：指定允許帶正負號的整數。

  • DecimalNumbers：指定允許十進位數字。

  • SignedDecimalNumbers：指定允許帶正負號的十進位數字。

MaxLength

選擇性的 ControlType 屬性，只有在搭配 FieldControl 使用時才會有效。

指定欄位控制項的允許字元最大長度。 屬性型別為 xs:integer。

Format

選擇性的 ControlType 屬性，只有在搭配 DateTimeControl 使用時才會有效。

指定日期時間欄位的格式，此格式會對應於 DateTimePickerFormat 列舉的一個值。 您可以使用的有效值如下所示：

  • Custom：以自訂格式顯示日期/時間值。 指定 'Custom" 做為 Format 屬性的值，並以自訂格式字串設定名為 CustomFormat 的另一個屬性，即可設定自訂格式。 例如：

    Format="Custom"

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

    如需詳細資訊，請參閱 Microsoft 網站：DateTimePicker.CustomFormat 屬性 (英文)。

  • Long：以使用者之作業系統所設定的長日期格式，來顯示日期/時間值。

  • Short：以使用者之作業系統所設定的短日期格式，來顯示日期/時間值。

  • Time：以使用者之作業系統所設定的時間格式，來顯示日期/時間值。

如需詳細資訊，請參閱 Microsoft 網站：DateTimePickerFormat 列舉型別 (英文)。

CustomFormat

只有在搭配 DateTimeControl 屬性和 Format 屬性使用時，才會有效的選擇性 ControlType 屬性。

指定日期時間欄位的自訂格式，此格式會對應於為 DateTimePicker.CustomFormat 屬性定義的語法。 如需詳細資訊，請參閱 Microsoft 網站：DateTimePicker.CustomFormat 屬性 (英文)。

子項目

項目

描述

LabelText

選擇性項目。 ControlType 指定為 FieldControl 或 LabelControl 時，您可以指定這個項目。

容器項目，用於指定文字、超連結，以及其文字與超連結部分相關的欄位或標籤位置。

如需詳細資訊，請參閱 LabelText 和 Text XML 項目參考和在工作項目表單上提供說明文字、流程指引、Web 內容和網頁的連結。

Link

選擇性項目。 ControlType 指定為 FieldControl 或 LabelControl 時，您可以指定這個項目。

定義欄位或標籤的超連結。

如需詳細資訊，請參閱 Link 和 Param XML 項目參考和在工作項目表單上提供說明文字、流程指引、Web 內容和網頁的連結。

LinksControlOptions

選擇性項目。 ControlType 指定為 LinksControl，您可以指定這個項目。

定義用於顯示連結清單之欄欄位 (Column Field) 的連結篩選條件和配置。

如需詳細資訊，請參閱定義連結控制項以限制連結關聯性。

WebpageControlOptions

選擇性項目。 ControlType 為 WebpageControl 時，您可以指定這個項目。

指定控制項，會管理工作項目表單中網頁目標的載入。

如需詳細資訊，請參閱 WebpageControlOptions XML 項目參考和在工作項目表單上提供說明文字、流程指引、Web 內容和網頁的連結。

anyAttribute

選擇性項目。

選擇項。 ControlType 可透過使用 anyAttribute 項目擴充。 ProcessContents：略過。

父項目

項目

描述

Layout

必要項。 定義如何在工作項目表單上顯示項目。

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" />

項目資訊

命名空間

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

結構描述名稱

工作項目類型定義

驗證檔

WorkItemTypeDefinition.xsd

項目型別

ControlType 複雜類型。

可以是空白

不適用

請參閱

概念

設計和自訂工作項目表單

所有 FORM XML 項目參考

指定工作項目表單控制項

變更記錄

日期

記錄

原因

2011 年 1 月

已加入子項目至語法，並移除或取代已移除之主題的連結。

資訊加強。