所有 FORM XML 項目參考

發行項
02/28/2013

您可以使用本主題中的資訊，快速參考所有用於控制工作項目類型表單的項目和主要屬性。這些項目都是在 FORM 項目容器中指定，這是工作項目類型定義的第三個也是最終的主要區段。許多項目都會彼此巢狀，構成工作項目表單中的群組、區段或索引標籤。如需如何將這些項目分組的詳細資訊，請參閱設計工作項目表單的配置。

本主題內容

FORM 範例
FORM 項目的語法
FORM 項目指定的屬性
用於指定獨立標籤、超連結、網頁或 HTML 內容的項目
用於篩選和顯示連結關聯性的項目

FORM 範例

下列範例會示範 FORM 項目的整體結構。您可以使用 Layout 項目，指定表單配置。您可以不同的用戶端為目標，指定不同的配置。例如，您可以為 Windows 用戶端指定某個配置，而為 Team Web Access 指定不同的配置。配置通常由表單頂端和索引標籤群組所組成。配置內定義項目的順序決定了表單上顯示項目的順序。

您可以使用 Group 與 Column 項目，藉此將資料行內顯示的項目分組。使用 Control 項目，定義要在表單上顯示的每個欄位。使用 Tab 項目，支援欄位群組的不同功能區域。

<FORM>
      <Layout>
        <Group>
          <Column PercentWidth="70">
            <Group>
              <Column PercentWidth="100">
                <Control FieldName="System.Title" Type="FieldControl" Label="Title" LabelPosition="Left" />
                <Control FieldName="System.AreaPath" Type="WorkItemClassificationControl" Label="Area Path" LabelPosition="Left" />
                <Control FieldName="System.IterationPath" Type="WorkItemClassificationControl" Label="&amp;Iteration Path:" LabelPosition="Left" />
                <Group>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.ProductUnit" Type="FieldControl" Label="PU (Use Area Path)" LabelPosition="Left" />
                  </Column>
                  <Column PercentWidth="50">
                    <Control FieldName="Microsoft.VSTS.Common.Priority" Type="FieldControl" Label="Priority" LabelPosition="Left" />
                  </Column>
                </Group>
              </Column>
            </Group>
          </Column>
          <Column PercentWidth="30">
            <Group Label="Status">
              <Column PercentWidth="100">
                <Control FieldName="System.Id" Type="FieldControl" Label="Id" LabelPosition="Left" />
                <Control FieldName="System.State" Type="FieldControl" Label="State" LabelPosition="Left" />
                <Control FieldName="System.AssignedTo" Type="FieldControl" Label="Assigned To" LabelPosition="Left" />
              </Column>
            </Group>
          </Column>
        </Group>

. . .
</Layout>
</FORM>

表單項目

您可以使用下表中說明的項目，指定要如何將資訊和工作項目欄位分組並顯示在工作項目表單中。

注意事項
為了得到最佳結果，您應該將 Control 項目巢狀在 Group 中，並且將 Group 項目巢狀 Column 中，即使這個資料行會延展到整個表單的寬度也一樣。另外，即使群組沒有可見的標籤或界限，您也應該將每個 Column 區段都巢狀在 Group 中。

元素	描述	是否為必要項？
Column	將表單的區域分成資料行。 `<Column PercentWidth="WidthPerceOfContainingElement" FixedWidth="WidthInPixels"> <Group> . . . </Group <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Column >`	建議使用
Control	定義要顯示在工作項目表單上的欄位、文字、超連結或其他控制項項目。 `<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" />` 如需詳細資訊，請參閱Control XML 項目參考。	必要項
FORM	定義最上層表單項目。 `<FORM> <Layout> . . . </Layout> </FORM>`	必要項
Group	提供項目的視覺化群組，類似於 Windows GroupBox。 `<Group Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)"> <Column> . . . </Column> </Group >`	建議使用
Layout	定義工作項目表單的配置。 `<Layout Target="ClientName" MinimumSize="(width,height)" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)" ControlSpacing="Distance" LabelSpacing="Distance"> <Group> . . . </Group> <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Layout>`	必要項
Splitter	將表單分割為兩個區域，以支援兩個同層級表單項目的配置。 `Splitter Dock="Left" />`	選擇項
Tab	定義索引標籤群組中單一索引標籤的配置。 `<Tab Label="LabelText" Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)"> <Group> . . . </Group <Control> . . . </Control> <TabGroup> . . . </TabGroup> <Splitter> . . . </Splitter> </Tab>`	選擇項
TabGroup	定義表單的一個或多個索引標籤。 `<TabGroup Padding="(left, top, right, bottom)" Margin="(left, top, right, bottom)"> <Tab> . . . </Tab> </TabGroup>`	選擇項

回到頁首

用於格式化 FORM 項目的屬性

您可以指定下表中說明的屬性，控制許多工作項目表單項目的間距和大小。如需詳細資訊，請參閱設計工作項目表單的配置。

屬性	描述	適用的項目
ControlSpacing	選擇項。指定控制項的垂直位移。整數。	Layout
Dock	選擇項。延伸欄位控制項或分隔器，以填滿容器的剩餘空間。有效的欄位停駐值如下：Fill、Top、Bottom、Left 和 Right。 Fill：對齊欄位使容器填滿。 Top：欄位會對齊容器的上層。 Bottom：欄位會對齊容器的底部。 Left：欄位或分隔器會對齊容器的左側。這個值是 SPLITTER 項目唯一支援的方向。 Right：欄位或分隔器會對齊容器的右側。	Control Splitter
FixedWidth	選擇項。資料行的寬度，以像素為單位。PercentWidth 和 FixedWidth 是互斥的。	Column
Label	選擇項。要為控制項或群組顯示的文字。如果指定標籤，則它會覆寫控制項的中繼資料中與欄位相關聯的任何標籤。 Tab 項目所需。要為索引標籤顯示的文字。 LabelText 是由 1 到 80 個字元組成的文字字串。	Control Group Tab
LabelPosition	選擇項。相對於欄位資料的標籤位置。可能的值為 Top、Bottom、Left 和 Right。	Control
LabelSpacing	選擇項。指定標籤和控制項編輯區域之間的像素數。	Layout
Margin	選擇項。(left, top, right, bottom) 格式的字串，指定控制項周圍以及控制項與相鄰項目之間的空間量 (以像素為單位)。每一邊的距離不一定要相同。模式值：^$\d+\,\d+\,\d+\,\d+$$ 模式值範例：(2,0,2,0)	Control Group Layout Tab TabGroup
MinimumSize	選擇項。(width, height) 格式的字串。這個值會指定表單本身最小的大小。如果容器控制項的大小比這個值還要小，就會出現水平與垂直捲軸。	Control Layout
Name	選擇項。控制項的名稱。如果沒有指定，此名稱會和 FieldName 相同。	Control
Padding	選擇項。(left, top, right, bottom) 格式的字串，指定控制項外框線周圍以及內框線周圍的空間量 (以像素為單位)。每一邊的距離不一定要相同。	Control Group Layout Tab TabGroup
PercentWidth	選擇項。資料行寬，以收納項目寬度的百分比表示。PercentWidth 和 FixedWidth 是互斥的。	Column
ReadOnly	選擇項。您可以在控制項中顯示唯讀欄位。不同的控制項對於這個屬性的回應方式會稍有不同。	Control
Target	選擇項。指定要套用這個配置的用戶端。如果 Target 屬性省略或設定為 Windows Forms，則 Visual Studio 會以這個配置來顯示此工作項目類型。外部用戶端可以使用 Visual Studio 所忽略的自訂 Target 屬性來指定其他配置。下列是有效值： WinForms：將表單套用至 Team Explorer和 Team Explorer Everywhere。 Web：將表單套用至 Team Web Access。	Layout
Type	必要項。控制項的型別。如需詳細資訊，請參閱Control XML 項目參考。	Control

回到頁首

用於指定獨立標籤、超連結、網頁或 HTML 內容的項目

WebpageControlOptions 項目及其子項目有下列語法結構：

<WebpageControlOptions AllowScript="true | false" ReloadOnParamChange="true | false" >
   <Link UrlRoot="UrlRoot" UrlPath ="UrlPathWithParameters">
      <Param index="IndexValue" value="ParamValue" type ="Original | Current"/>
   </Link>
   <Content>
      <![CDATA[Contents of HTML]]>
   </Content>
</WebpageControlOptions>

您可以使用下表中說明的項目，在工作項目表單中定義純文字或超連結標籤、將超連結加入至欄位，或顯示網頁內容。如需詳細資訊，請參閱在工作項目表單上提供說明文字、流程指引、Web 內容和網頁的連結。

元素	是否為必要項？	描述
Content	選擇性 WebpageControlOptions 項目。	指定要顯示在工作項目表單中的 CDATA HTML 型內容。 `<Content> <![CDATA[Contents of HTML]]> </Content>` 如需詳細資訊，請參閱WebpageControlOptions XML 項目參考。
LabelText	當 type="LabelControl" 時，選擇性 Control 項目。	定義純文字標籤或超連結標籤。如需詳細資訊，請參閱LabelText 和 Text XML 項目參考。
Link	當 type="FieldControl" 時，選擇性 Control 項目。選擇性 Text 項目。選擇性 WebpageControl 項目。選擇性 WebpageControlOptions 項目。	針對要顯示在工作項目表單上的欄位、標籤或 Web 瀏覽器內容，定義超連結。 `<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters"> <Param /> </Link>` 如需詳細資訊，請參閱Link 和 Param XML 項目參考。
Param	選擇性 Link 項目。	指定值，當 Link 項目指定 URLPath 時，這個值決定超連結的 URL。 `<Param index="IndexValue " value="ParamValue " type ="Original \| Current"/>` 如需詳細資訊，請參閱Link 和 Param XML 項目參考。
Text	選擇性 LabelText 項目。	容器項目，容納要顯示在工作項目表單上的資訊或標籤。 `<Text> <Link > <Param /> </Link> LabelText </Text>` 如需詳細資訊，請參閱LabelText 和 Text XML 項目參考。
WebpageControlOptions	當 type="WebpageControl" 時，選擇性 Control 項目。	用於指定網頁控制項之選項的容器項目。如需詳細資訊，請參閱WebpageControlOptions XML 項目參考。

回到頁首

用於篩選和顯示連結關聯性的項目

您可以使用 LinksControlOptions 項目來定義選項，以控制可加入至工作項目的連結，以及您要針對工作項目中的連結清單顯示的預設資料行。當您將連結控制項加入至工作項目表單時，您可以指定篩選條件，以限制使用者可建立的連結類型，並限制使用者可在哪些類型的工作項目之間建立連結。LinksControlOptions 項目及其子項目有下列結構：

<LinksControlOptions>
   <WorkItemLinkFilters FilterType="include | exclude | includeAll | excludeAll">
       <Filter LinkType="linkTypeRefName" FilterOn="reverseName | forwardName" />
   </WorkItemLinkFilters>
   <ExternalLinkFilters FilterType ="include | exclude | includeAll | excludeAll">
       <Filter LinkType="externalLinkName"/>
   </ExternalLinkFilters>
   <WorkItemTypeFilters Scope=" project | all" FilterType=" include | exclude | includeAll" />
       <Filter WorkItemType="workItemTypeReferenceName"/>
   </WorkItemTypeFilters>
   <LinkColumns>
      <LinkColumn RefName="referenceName" | LinkAttribute="linkAttributeName"/>
   </LinkColumns>
</LinksControlOptions>

具體來說，您可以使用下表中摘要說明的項目。如需如何使用這些項目的詳細資訊，請參閱定義連結控制項以限制連結關聯性和 LinksControlOptions 項目。

元素	是否為必要項？	描述
LinksControlOptions	當 type="LinksControl" 時，選擇性 Control 項目。	提供項目的容器，這些項目定義選項，以控制可加入至工作項目的連結，以及您要針對工作項目中的連結清單顯示的預設資料行。
WorkItemLinkFilters	選擇性 LinksControlOptions 項目	提供一個或多個 Filter 項目的容器，這些項目指定連結篩選準則，而這些準則要用於 Team 專案集合所定義的連結類型。
ExternalLinkFilters	選擇性 LinksControlOptions 項目	提供一個或多個 Filter 項目的容器，這些項目指定要篩選其他 Team 專案中定義的連結類型時，所要使用的篩選準則。
WorkItemTypeFilters	選擇性 LinksControlOptions 項目	提供一個或多個 Filter 項目的容器，這些項目指定要套用至工作項目類型的篩選準則。
Filter (連結類型)	當 FilterType 屬性是 exclude 或 include 時，必要 WorkItemLinkFilters 項目。當 FilterType 屬性是 exclude 或 include 時，必要 ExternalLinkFilters 項目。	針對可為工作項目建立的連結集，指定要包含或排除的連結類型。
Filter (工作項目類型)	當 FilterType 屬性是 exclude 或 include 時，選擇性 WorkItemTypeFilters 項目。	針對可讓使用者在工作項目類型間建立連結的工作項目類型集，指定要包含或排除的工作項目類型。
LinkColumns	選擇性 LinksControlOptions 項目	提供一個或多個 LinkColumn 標記的容器。
LinkColumn	必要 LinkColumns 項目	針對連結清單，指定要顯示在工作項目表單上的工作項目欄位和連結類型屬性。

回到頁首

請參閱

概念

設計工作項目表單的配置

設計和自訂工作項目表單

其他資源

工作項目類型的 XML 項目定義索引

共用方式為

所有 FORM XML 項目參考

FORM 範例

表單項目

用於格式化 FORM 項目的屬性

用於指定獨立標籤、超連結、網頁或 HTML 內容的項目

用於篩選和顯示連結關聯性的項目

請參閱

概念

其他資源

其他資源