WebpageControlOptions XML 項目參考

更新：2011 年 5 月

您可以使用 WebpageControlOptions 項目來顯示針對網頁定義的內容，或是工作項目表單上之 CDATA 標記內的內容。 您可以包含 Link或 Content 子項目，指定要顯示在表單中的內容的 URL 或 HTML。

WebpageControlOptions 項目是 CONTROL 項目的子項目。

結構描述階層架構

WITD

   WORKITEMTYPE

       FORM

           Layout

               Group

               Column

               TabGroup

                  Tab

                     Control

<xs:element name="WebpageControlOptions" type="WebpageControlOptionsType" minOccurs="0" maxOccurs="1" />
<xs:element name="Link" type="HyperLinkType" minOccurs="0" maxOccurs="1" />
<xs:element name="Param" type="HyperLinkParamType" minOccurs="0" maxOccurs="unbounded"/>

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

屬性和項目

下列各節將說明屬性、子項目和父項目。

子項目及屬性

項目	屬性	描述
WebpageControlOptions		當 type="WebpageControl" 時，選擇性 Control 項目。 定義 URL 的容器項目，此 URL 的內容會在工作項目表單中呈現。 選擇性 LINK 項目。 指定 UrlPath 時為必要項。 指定值，當指定 UrlPath 時，這個值用於決定超連結的 URL。 項目型別是複雜型別：WebpageControlOptionsType。
	AllowScript	選擇性 WebpageControlOptions 屬性。 指定是否允許執行網頁內的 JavaScript (true 表示允許、false 表示不允許)。 屬性型別為 xs:boolean。 所有其他設定 (例如 ActiveX) 都是以該用戶端設定的 Internet Explorer 設定為基礎。
	ReloadOnParamChange	選擇性 WebpageControlOptions 屬性。 指定當工作項目表單中的參數變更時 (true) 是否要重新載入 (true) 網頁的內容 (false 表示不重新載入)。 屬性型別為 xs:boolean。 預設值是 true。
Link		選擇性 WebpageControlOptions 項目。 這個項目與 Content 項目互斥。 指定要在工作項目表單中呈現的網頁 URL。 如需詳細資訊，請參閱Link 和 Param XML 項目參考。
Content		選擇性 WebpageControlOptions 項目。 這個項目與 Link 項目互斥。 指定要由 Web 網頁控制項所呈現的 HTML 內容。 內容會在 CDATA 標記內指定。 例如： <![CDATA[Click here for detailed <b><a href="http://www.microsoft.com">Process Guidance</a></b>]]> 項目型別是 xs:string。 注意事項 在工作項目表單中呈現 HTML 內容之前，不會驗證該內容。

父項目

項目	描述
Control	必要的父項目。 定義要顯示在工作項目表單上的欄位、文字、超連結或其他控制項項目。
Text	選擇性 LabelText 項目。 容器項目，容納要顯示在工作項目表單上的資訊或標籤。 如需詳細資訊，請參閱LabelText 和 Text XML 項目參考。

備註

Link 和 Content 項目互斥。

使用 Content 項目時，不允許使用 AllowScript 和 ReloadOnParamChange 屬性。

將網頁控制項設定為顯示未經處理的 HTML 時，會停用所有指令碼處理。 如果工作項目表單顯示在 Visual Studio 或 Internet Explorer 中，內容中任何按下的超連結都會在 Visual Studio Web 瀏覽器中開啟。

在包含 WebpageControl 的索引標籤中，會將數個工具列按鈕加入志工作項目標表單。 這些選項包括下列函式：

• 向後和向前巡覽

• 停止內容載入並重新整理內容

• 返回內容首頁

• 在新視窗或外部瀏覽器中開啟內容

此外，如果要載入的網頁包含不受信任的內容，就會封鎖圖示並出現封鎖的圖示。

只有執行最新版 Team 總管 的用戶端能辨識 WebpageControlOptions 項目。 在舊版中會顯示紅色區域，並出現一個訊息，表示找不到控制項。 如需詳細資訊，請參閱在工作項目表單上提供說明文字、流程指引、Web 內容和網頁的連結。

範例

下列範例示範如何載入工作項目表單 (在 CDATA 標記定義了 HTML)。

<Control Type="WebpageControl">
   <WebpageControlOptions>
      <Content>
         <![CDATA[Click here for detailed <b><a href="https://www.microsoft.com">Process Guidance</a></b>]]>
      </Content>
   </WebpageControlOptions>
</Control>

結構描述定義

WebpageControlOptionsType

<xs:complexType name="WebpageControlOptionsType">
   <xs:choice minOccurs="1" maxOccurs="1">
      <xs:element name="Link" type="HyperLinkType"/>
      <xs:element name="Content" type="xs:string"/>
   </xs:choice>
      <xs:attribute name="AllowScript" type="xs:boolean" use="optional" />
      <xs:attribute name="ReloadOnParamChange" type="xs:boolean" use="optional" />
</xs:complexType>

NonBlankString

<xs:simpleType name="NonBlankString">
   <xs:restriction  base="xs:string">
   <xs:pattern value=".*\S+.*"/>
   </xs:restriction>
</xs:simpleType>

項目資訊

命名空間	https://schemas.microsoft.com/VisualStudio/2008/workitemtracking/typedef
結構描述名稱	工作項目類型定義
驗證檔	WorkItemTypeDefinition.xsd
項目型別	WebpageControlOptionsType
可以是空白	不適用

請參閱

概念

指定工作項目表單控制項

設計和自訂工作項目表單

其他資源

在工作項目表單上提供說明文字、流程指引、Web 內容和網頁的連結

變更記錄

日期	記錄	原因
2011 年 5 月	已更正幾個 XML 語法項目及屬性的案例。 追蹤工作項目結構描述會將 FORM 項目的所有子項目定義為依照 Camel 命名法的大小寫慣例，而將其他所有項目名稱中的字母全部大寫。	內容 Bug 修正。
2011 年 1 月	將已移除之主題的連結移除。	資訊加強。