Share via

指定工作項目表單控制項

  • 發行項

TFS 2015 |TFS 2013

重要

本主題適用于內部部署 XML 進程模型的專案自訂。 如需裝載的 XML 進程模型，請參閱 WebLayout 和 Control 元素。 如需繼承進程模型，請參閱 自訂進程。

如需流程模型的總覽，請參閱 自訂您的工作追蹤體驗。

針對您想要在工作專案表單上顯示的每個欄位或表單控制項，您可以加入 Control 元素。 您可以自訂工作項目表單，以顯示有助於小組正確使用表單的資訊。 您可以加入工作項目欄位和控制項，以便輸入和檢視您要追蹤的資料。

Control元素提供數個資料類型值，可供 Type 您用來加入欄位或顯示純文字或超連結文字或欄位。 此外，您也可以定義特別控制項，以加入連結和附件、顯示 Web 內容，或建立自己的控制項並將它加入至工作項目表單。

您可以控制工作項目表單上純文字、整數、數字、日期和樹狀路徑工作項目欄位的標籤名稱、位置、文字方塊大小和其他顯示控制項。 若要顯示這些欄位，您必須從下列選項指定正確 Control 的元素 Type 屬性：

  • FieldControl：用來顯示純文字或數值欄位，以及欄位類型 Boolean 為、 IdentityString 、、 Integer 、 Double 和 PlainText 的欄位值清單。

  • HtmlFieldControl：用來顯示資料行、rtf 格式欄位的欄位資料類型 HTML 。

  • DateTimeControl：用來顯示欄位類型為的 DateTime 格式化日期欄位。

  • WorkItemClassificationControl 用來顯示欄位類型為的 TreePath 階層式路徑欄位。

加入工作項目欄位

當您自訂工作項目表單時，您通常會加入一小組工作項目欄位，這些欄位是針對您要在表單上顯示的工作項目類型所定義的。 欄位定義可控制顯示哪些資料或可在表單中輸入哪些資料的許多層面。 如需詳細資訊，請參閱 修改欄位或加入自訂欄位。

每個工作項目欄位會與一種資料類型產生關聯。 Label您可以使用屬性來指定在控制項旁邊顯示的文字。 您可以使用相關 LabelPosition 屬性來指定標籤相對於控制項的顯示位置。

注意

您無法變更系統欄位的值（這些值會自動更新）。 例如，在第一次儲存工作項目時會定義 [建立日期] 和 [建立者] 欄位。 不過，您可以在搜尋條件中使用這些欄位。 如需每個系統欄位的說明，請參閱 工作專案欄位索引。

新增數值欄位

使用 FieldControl 為整數位段提供控制項欄位。

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

用 FieldControl 來提供輸入或顯示雙精度浮點數欄位的文字欄位。

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

新增純文字或字串欄位

String當您想要新增字串欄位（例如在挑選清單或簡短文字中使用，其限制為255個字元）時，請指定控制項。

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

PlainText當您想要捕捉的文字包含可能大於255個字元的描述時，請指定控制項。

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

新增核取方塊或布林值欄位

注意

功能可用性：適用于 TFS 2017.2 和更新版本的 Hosted xml (Azure DevOps Services) 和內部部署 xml 支援布林資料類型。

使用下列語法，在 WIT 定義的 FIELDS 區段內加入布林值欄位。

<FIELD name="Triage" refname="Fabrikam.Triage" type="Boolean" >
  <DEFAULT from="value" value="False" />
  <HELPTEXT>Triage work item</HELPTEXT>
</FIELD>

然後，在 表單 區段內加入下列語法，讓欄位出現在表單上。

<Control Label="Triage" Type="FieldControl" FieldName="Fabrikam.Triage" />

此欄位會顯示為表單上的核取方塊。

加入日期或行事曆欄位

您可以使用 DateTimeControl 類型為使用者提供行事曆選擇器，以選取欄位的日期 DateTime 。 使用這個控制項，您即可快速地選取欄位的日期和時間。

具有 Format="Short" 的行事曆欄位
Calendar field

例如，您可以指定未來的慣用開始日期或檢閱日期。

<Control Type="DateTimeControl" FieldName="MyCompany.EnvironmentCR.PreferredStart"  
Label="Preferred Start Date:" LabelPosition="Left" Format="Short" />  
<Control Type="DateTimeControl" FieldName="MyCompany.EnvironmentCR.PreferredStartTime"  
Label="Preferred Start Time:" LabelPosition="Left" Format="Time" />

您可以使用下表所述的選擇性屬性來控制欄位的格式 DateTime 。

屬性 描述
Format 指定日期時間欄位的格式，此格式對應於 DateTimePickerFormat 列舉的其中一個值。 有效的值如下： Custom 、 Long 、 Short 、 Time 。

當您指定 Custom 時，您也必須設定 CustomFormat 屬性。
CustomFormat 指定用於日期時間欄位的自訂格式，此格式對應於為 DateTimePicker.CustomFormat 屬性定義的語法。 例如：

Format="Custom"

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

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

將 rich text (HTML) 欄位

HTMLControl指定加入 HTML 欄位來捕捉 rich text 格式，如下圖所示。

<Control Type="HtmlFieldControl" FieldName="Microsoft.VSTS.Notes" Label="Notes" Dock="Fill" />

HTML field shown on work item form

提示

當您在將會垂直堆疊的表單上加入數個 HTMLFieldControl 專案時，您應該指定每個欄位控制項的 MinimumSize 屬性。 如此，您可以將文字方塊全部設為相似大小。 否則，最後一個 HTML 控制項項目會調整大小以填滿表單，而前面的項目會以較小的文字方塊一起顯示。

新增純文字或超連結的文字控制項

LabelControl使用顯示未與欄位相關聯的純文字或超連結文字，如下圖所示。

您可以使用 LabelText 和 Link 子系和容器元素，來指定文字與超連結部分相關之欄位或標籤的文字、超連結和位置。 如需詳細資訊，請參閱 提供解說文字、超連結或 web 內容、 LabelText 和文字，以及 連結和參數。

Example of two hyperlinks applied to text

新增網頁控制項

用 WebpageControl 來顯示工作專案表單中的 Web 內容。 這個控制項通常包含在它自己的索引標籤群組中。 您可以使用 WebpageControlOptions 和 Link 子專案，指定在工作專案表單中載入網頁目標所需的控制項。

如需詳細資訊，請參閱 編輯 WIT 定義，以將 web 內容加入至工作專案表單、 WebpageControlOptions，以及 連結和參數。

您可以使用 LinksControl 來建立和管理工作專案之間的連結。 這個控制項通常包含在它自己的索引標籤群組中，如下圖所示。

Example of links control added to a work item form

您也可以使用 LinksControlOptions 來定義用來顯示連結清單之資料列欄位的連結篩選和版面配置。 如需詳細資訊，請參閱 定義連結控制項以限制連結關聯 性和 LinksControlOptions。

新增 Storyboard 控制項

StoryboardsControl使用從工作專案開啟 PowerPoint 分鏡腳本，並連結至儲存至網路共用的分鏡腳本檔案。 這個控制項通常包含在它自己的索引標籤群組中，如下圖所示。

Storyboard links control

若要將加入 StoryboardsControl 至 FORM 區段，請新增下列程式碼片段：

<Tab Label="Storyboards">
     <Control Name="StoryboardsControl" Type="LinksControl">
        <LinksControlOptions>
           <WorkItemLinkFilters FilterType="excludeAll" />
           <ExternalLinkFilters FilterType="include">
              <Filter LinkType="Storyboard" />
           </ExternalLinkFilters>
           <LinkColumns>
              <LinkColumn RefName="System.Title" />
              <LinkColumn LinkAttribute="System.Links.Comment" />
           </LinkColumns>
        </LinksControlOptions>
     </Control>
  </Tab>

(TreePath 控制項) 新增區域和反復專案路徑

您可以使用 WorkItemClassificationControl 型別加入資料型別為 TreePath 的欄位。 這個控制項支援以階層式、巢狀樹狀來顯示區域路徑欄位與反覆項目路徑欄位。 樹狀結構會顯示您可以展開與摺疊的階層式節點。

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

注意

您可以使用 WorkItemClassificationControl 來顯示 System.AreaPath 和 System.IterationPath 欄位。 您無法使用這個控制項來顯示其他類型的欄位或自訂欄位。

新增歷程記錄控制項

您可以使用 WorkItemLogControl 為記錄欄位提供控制欄位，以追蹤討論串和其他歷程記錄資訊，如下圖所示。

History tab and field on work item form

這個控制項只能用來支援顯示工作項目記錄欄位 (System.History 工作項目欄位)。 使用這個控制項，您可以展開與摺疊工作項目歷次修訂的詳細資料。 您也可以格式化加入至記錄欄位的文字。

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

新增附件控制項

AttachmentsControl使用將檔案附加至工作專案表單。 這個控制項通常包含在它自己的索引標籤群組中，如下圖所示。

Attach files to a work item

如需詳細資訊，請參閱 新增附件控制項。

除了提供的內建控制項之外，您還可以在中找到其他可使用的控制項。 或者，您可以建立自己的控制項。 請參閱 擴充工作專案表單。

在表單的兩個地方標示欄位和加入欄位

針對每個表單控制項，您可以使用 Label 和 LabelPosition 屬性，指定選擇性的標籤和標籤的位置。 標籤可以指定與元素所指派 FIELD 的易記名稱不同的名稱。 如果您未指定標籤，則會使用易記名稱。 不過，請注意當小組成員執行查詢以搜尋工作項目時，一律使用易記名稱。 標籤大小上限是 80 個字元。

注意

您必須對定義在相同群組中的所有控制項定義相同的標籤位置。

如果您想要在表單的多個區域中新增欄位，例如表單頂端和索引標籤上的欄位，可以使用 Name 屬性來進行。 Name屬性只會將控制項識別為不同于加入至表單的另一個控制項。

將欄位設為唯讀

您可以用下列兩種方式將欄位設為唯讀的。 在第一個方法中，您會在類型定義的 FIELDS 區段中，將專案加入 READONLY 為專案的子 FIELD 系。 藉由使用 READONLY 專案，您可以指定特定使用者是否可以修改欄位。 如下列範例所示，只有程式管理人員才能修改子標題欄位。

<FIELD name="Sub-Title" refname="ACME.ACE.SubTitle" type="String" >  
<READONLY for="[Global]\Team Foundation Valid Users" not="Program Managers"/>  
</FIELD>

在第二個方法中，您會指定元素的 ReadOnly 屬性 CONTROL 。 這個方法會限制所有使用者修改欄位。

<Control FieldName=" ACME.ACE.SubTitle" Type="FieldControl" Label="Sub-Title" LabelPosition="Left" ReadOnly="True" />

所有控制項類型的選擇性控制項目欄位屬性

僅可以針對列出的控制項類型指定下列選擇性屬性。

注意

每個資料輸入欄位的整體大小由數個因素決定：指派給欄位的屬性、容器大小，以及配置給表單上其他欄位的區域。 如果您未指定大小下限，則會指派預設值給欄位。 不過，指派給其他表單欄位的屬性可能會影響欄位大小。 資料行數目和您配置給每個資料行之最大欄位的水平大小會決定表單的水平維度。 您在垂直群組中指定的欄位數目以及配置給每個欄位的垂直大小，會決定表單頂端大小和表單底部大小。

屬性 描述
Field 指定與工作項目欄位相關聯的控制項。
Label 指定表單上可識別控制項的可見文字。 指定長度不超過 80 個字元的字串。

注意： 您可以使用 將超連結附加至加入至工作專案表單之欄位的標籤。 對欄位使用方式的相關資訊提供連結時，這個控制項很實用。 如需詳細資訊，請參閱 提供解說文字、超連結或 web 內容。
LabelPosition 指定標籤相對於控制項資料的位置。 從下列其中一個值指定字串： Top 、 Bottom 、 Left 和 Right 。
Dock 指定標籤與容器指定的一邊的對齊方式，或讓欄位延伸以填滿容器。 從下列其中一個值指定字串： Fill 、 Top 、 Bottom 、 Left 和 Right 。
Padding 指定控制項內框線周圍的空間 (以像素為單位)。 會提供四個對應於上、下、左、右的值。 例如：(2,0,2,0)。
Margin 指定控制項外框線周圍的空間 (以像素為單位)。 會提供四個對應於上、下、左、右的值。 例如：(2,0,2,0)。
ReadOnly 指定欄位是唯讀的。 指定 True 或 False。
MinimumSize 指定控制項在表單中應佔據的大小下限 (以像素為單位)。 會指定兩個對應於寬度和高度的值。 例如：(100,100)。
Name 唯一識別控制項。 Name如果表單上有一個以上的控制項與相同工作專案欄位相關聯，則需要屬性。

注意： 您可以使用 屬性，在表單上的一個以上區域中顯示相同的欄位。 您可以為這兩個控制項專案的屬性指定唯一的值 Name ，讓系統能夠唯一識別每個控制項。 根據索引標籤的內容在各種位置顯示相同的控制項時，這個屬性很有用。

特定控制項類型的選擇性控制項目欄位屬性

僅可以針對列出的控制項類型指定下列選擇性屬性。

屬性 控制項類型 Description
NumberFormat FieldControl 指定您可以在欄位控制項中輸入的字元。 下列值有效： WholeNumbers 、 SignedWholeNumbers 、 DecimalNumbers 和 SignedDecimalNumbers 。
MaxLength FieldControl 指定您可以用於欄位控制項的最大字元長度。
Format DateTimeControl 指定日期時間欄位的格式，此格式對應於 DateTimePickerFormat 列舉的其中一個值。 下列是有效的值： Custom 、 Long 、 Short 、 Time 。
CustomFormat DateTimeControl 指定用於日期時間欄位的自訂格式，此格式對應於為 DateTimePicker.CustomFormat 屬性定義的語法。