Link 和 Param XML 項目參考
您可以使用 Link 項目,為工作項目表單上的欄位或獨立標籤加入超連結。您使用下列執行個體中的 Link 項目執行下列功能:
在欄位標籤中加入超連結
在獨立式標籤或部分資訊性文字中加入超連結
指定要顯示在工作項目表單之內容的 URL
Link 項目若非 Control 項目的子項目,就是 WebpageControlTarget 或 WebpageControlOptions 項目的子項目。如需這些項目的詳細資訊,請參閱 Control XML 項目參考和 WebpageControlOptions XML 項目參考。
結構描述階層架構
<Link URLRoot="URLRoot" URLPath ="URLPathWithParameters">
<Param Index="IndexValue " Value="ParamValue " Type ="Original | Current"/>
</Link>
屬性和項目
下列章節會說明屬性、子項目和父項目。
子項目及屬性
元素 |
屬性 |
描述 |
---|---|---|
Link |
當 type="FieldControl" 時,選擇性 Control 項目。 選擇性 LabelText 項目。 選擇性 Text 項目。 選擇性 WebpageControlOptions 項目。 定義超連結或 URL 的容器項目。項目型別是複雜型別:HyperLinkType。 |
|
UrlRoot |
必要的 Link 屬性。 指定通訊協定,以及標籤所連結之 URL 的伺服器名稱。支援的通訊協定是 HTTP、HTTPS 和 MAILTO。 您可以將指定的伺服器名稱硬式編碼,或者您可以使用下列的一個巨集,而且選擇性地將其他地址資訊附加至巨集:
注意事項
每個巨集都有連結至 URL,此 URL 的定義與啟用,則是針對 Link 項目為其定義之工作項目表單的 Team 專案。如果沒有為 Team 專案提供或啟用任何資源,就會出現「找不到頁面」錯誤。
若要判斷前兩個巨集的硬式編碼值,您可以開啟 Team 專案的專案入口網站設定。如需詳細資訊,請參閱存取 Team 專案入口網站或流程指引。 屬性型別是簡單型別:NonBlankString。 |
|
UrlPath |
選擇性 Link 屬性。 指定超連結的 URL 路徑。您使用這個屬性來指定在執行階段決定的變數參數。屬性型別是簡單型別:NonBlankString。 |
|
Param |
選擇性 Link 項目。指定 UrlPath 時為必要項。 指定值,當指定 UrlPath 時,這個值用於決定超連結的 URL。 項目型別是複雜型別:HyperLinkParamType。 |
|
Index |
必要的 Param 屬性。 指定參數值的索引,必須將其中値的格式調整至 URL 字串中。不需要依序排序索引值,不過,索引值必須符合 URLPath 字串中的索引數目。 屬性型別為 PositiveInteger。第一個索引數字應該是 0。 |
|
Value |
必要的 Param 屬性。 指定與超連結的 URL 路徑值相關的數目。 指定必須格式化成 URLPath 字串的值。值必須是工作項目型別定義中使用之欄位的有效參考名稱。 支援 @Me 變數。它已改為目前正在檢視工作項目表單的 Team 成員。有效的值項目不區分大小寫 屬性型別為 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 屬性所指定的文字會出現在工作項目表單中。
範例: 以參數指定超連結
描述
下列範例示範如何定義超連結,此超連結會連結至反覆項目主題的流程指引:
https://serverName/sites/collectionName/projectName/render.aspx?wit=bug&topic=Iteration
專案的名稱衍生自指派給 System.Project 欄位的值。
程式碼
<Link UrlRoot="https://serverName" UrlPath="sites/{0}/render.aspx?wit=bug&topic=Iteration">
<Param Index="0" Value="System.Project" />
</Link>
範例:在獨立的標籤中加入超連結
描述
下列範例示範如何將超連結指派至工作項目表單上的文字「工作項目指引」。
程式碼
<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 |
可以是空白 |
不適用 |