Link 和 Param XML 項目參考
您可以使用 Link 項目,加入指向工作項目表單上之欄位或獨立標籤的超連結。 您可以使用下列執行個體中的 Link 項目執行下列作業:
加入指向欄位標籤的超連結
加入指向獨立標籤或部分資訊文字的超連結
指定要在工作項目表單中顯示之內容的 URL
若要將項目加入表單,您可以修改工作項目類型的定義。 請參閱 修改或加入自訂工作項目類型 (WIT)。
Link 項目若非 Control 項目的子項目,就是 WebpageControlTarget 或 WebpageControlOptions 項目的子項目。 如需這些項目的詳細資訊,請參閱 Control XML 項目參考及 WebpageControlOptions XML 項目參考。
結構描述階層架構
<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters"> <Param Index="IndexValue " Value="ParamValue " Type ="Original | Current"/> </Link>
屬性和項目
下列章節說明屬性、子項目和父項目。
子項目和屬性
項目 |
屬性 |
描述 |
||
---|---|---|---|---|
Link |
|
當 Control 時,選擇性 type="FieldControl" 項目。 選擇性 LabelText 項目。 選擇性 Text 項目。 選擇性 WebpageControlOptions 項目。 定義超連結或 URL 的容器項目。 項目類型是複雜類型:HyperLinkType。 |
||
|
UrlRoot |
必要的 Link 屬性。 指定通訊協定,以及標籤所連結之 URL 的伺服器名稱。 支援的通訊協定為 HTTP、HTTPS 和 MAILTO。 您可以將指定的伺服器名稱硬式編碼,或者您可以使用下列其中一個巨集,然後選擇性地將其他地址資訊附加至巨集:
若要判斷前兩個巨集的硬式編碼值,您可以開啟 Team 專案的專案入口網站設定。 如需詳細資訊,請參閱設定或重新導向流程指引。 屬性類型是簡單類型:NonBlankString。 |
||
|
UrlPath |
選擇性 Link 屬性。 指定超連結的 URL 路徑。 您可以使用這個屬性來指定在執行階段決定的變數參數。 屬性類型是簡單類型:NonBlankString。 |
||
Param |
|
選擇性 Link 項目。 指定 UrlPath 時為必要項目。 指定 UrlPath 時,可指定要用來判斷超連結 URL 的值。 項目類型是複雜類型:HyperLinkParamType。 |
||
|
Index |
必要的 Param 屬性。 指定參數的索引,其中參數值必須格式化為 URL 字串。 不需要依序排序索引值,不過,索引值必須符合 URLPath 字串中的索引編號。 屬性類型為 PositiveInteger。 第一個索引編號應該是 0。 |
||
|
Value |
必要的 Param 屬性。 指定與超連結的 URL 路徑值相關聯的數值。 指定必須格式化為 URLPath 字串的值。 這些值必須是工作項目類型定義中所使用之欄位的有效參考名稱。 支援 @Me 變數。 它會由目前正在檢視工作項目表單之小組成員的名稱取代。 有效的項目不區分大小寫。 屬性類型為 xs:string。 |
||
|
Type |
選擇性 Param 屬性。 指定參數必須使用欄位的原始值。 屬性類型是簡單類型:HyperLinkParamValueKind。 下列是有效值:
如果未指定這個屬性,則會使用該欄位的目前值做為參數。 |
父項目
項目 |
描述 |
---|---|
必要項。 定義要顯示在工作項目表單上的欄位、文字、超連結或其他控制項項目。 |
|
選擇性 Control 項目。 要出現在工作項目表單上之標籤的容器項目。 |
|
選擇性 LabelText 項目。 容器項目,容納要顯示在工作項目表單上的資訊或標籤。 |
|
選擇性 Control 項目。 用於指定網頁控制項之選項的容器項目。 |
備註
Link 項目的預設行為是開啟工作項目表單或網頁中的超連結。 如果撰寫的超連結需要以新視窗開啟 (target="_blank"),則會開啟外部瀏覽器。
您可以在 LabelText 項目中加入多個 Text 項目,以結合純文字和超連結文字。
只有執行最新版 Team Explorer 的用戶端才能辨識 LabelText 項目。 因此,當您指定 Link 子項目時,必須在 Control 項目中指定 Label 屬性。 若是執行最新版 Team Explorer 的用戶端,則工作項目表單中會出現 LabelText 項目所提供的文字。 若是執行舊版 Team Explorer 的用戶端,則工作項目表單中會出現 Control 項目的 Label 屬性所指定的文字。
範例:使用參數指定超連結
描述
下列範例示範如何定義連結至反覆項目主題之流程指引的超連結:
http://伺服器名稱/sites/集合名稱/專案名稱/render.aspx?wit=bug&topic=Iteration
專案的名稱衍生自指派給 System.Project 欄位的值。
程式碼
<Link UrlRoot="http://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&topic=Iteration">
<Param Index="0" Value="System.Project" />
</Link>
範例:加入指向獨立標籤的超連結
描述
下列範例示範如何將超連結指派給工作項目表單上的文字 "work item guidance"。
程式碼
<Control type="LabelControl">
<LabelText>
<Text>
<Link UrlRoot="https://www.msn.com" />
work item guidance
</Text>
</LabelText>
</Control>
範例:加入指向欄位的超連結
描述
下列範例示範如何加入指向工作項目表單上之欄位標籤的超連結。
程式碼
<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="This text comes from the Label attribute:">
<LabelText>
<Text>
<Link UrlRoot="http://www.live.com/" />
This text comes from the inner Label Text
</Text>
</LabelText>
</Control>
結構描述定義
HyperLinkType
NonBlankString
HyperLinkParamType
HyperLinkParamValueKind
複雜類型:HyperLinkType
<xs:complexType name="HyperLinkType" >
<xs:sequence>
<xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="UrlRoot" type="NonBlankString" use="required" />
<xs:attribute name="UrlPath" type="NonBlankString" use="optional" />
</xs:complexType>
HyperLinkParamType
<xs:complexType name="HyperLinkParamType" >
<xs:attribute name="Index" type="PositiveInteger" use="required" />
<xs:attribute name="Value" type="xs:string" use="required" />
<xs:attribute name="Type" type="HyperLinkParamValueKind" use="optional" />
</xs:complexType>
NonBlankString
<xs:simpleType name="NonBlankString">
<xs:restriction base="xs:string">
<xs:pattern value=".*\S+.*"/>
</xs:restriction>
</xs:simpleType>
HyperLinkParamValueKind
<xs:simpleType name="HyperLinkParamValueKind">
<xs:restriction base="xs:string">
<xs:enumeration value="Original"/>
<xs:enumeration value="Current"/>
</xs:restriction>
</xs:simpleType>
項目資訊
命名空間 |
https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef |
結構描述名稱 |
工作項目類型定義 |
驗證檔 |
WorkItemTypeDefinition.xsd |
項目類型 |
HyperLinkType, HyperLinkParamType |
可以是空白 |
不適用 |