Share via

Control XML 項目參考

  • 發行項

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

結構描述階層架構

WITD

   WORKITEMTYPE

       FORM

           配置

               群組

               Column

               索引標籤

<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_]+)+$

模式值範例：Company.Division.IssueType

Type

必要的 Control 屬性。

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

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

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

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

  • HtmlFieldControl：用來顯示多行、RTF 格式的欄位，具有 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 內容。

連結

選擇性項目。 您可以在 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 項目參考

指定工作項目表單控制項