WebpageControlOptions XML 元素引用
更新：2011 年 5 月
可以显示在工作项窗体的 Web 页或 CDATA 标记中定义的内容，方法是使用 WebpageControlOptions 元素。 您可以任意包括 Link 或 Content 子元素，以指定要出现在该表单中的内容的 URL 或 HTML。
WebpageControlOptions 元素是 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 的容器元素。 可选的 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 元素互相排斥。 为网页控件要呈现的 HTML 内容。 CDATA 标记中指定了内容。 例如： <![CDATA[Click here for detailed <b><a href="http://www.microsoft.com">Process Guidance</a></b>]]> 元素类型未 xs:string。 .gif "注意") 注意
HTML 内容在呈现于工作项表单之前，未进行验证。
|
父元素
元素 |
说明 |
|---|---|
必需的父级元素。 定义要在工作项窗体上显示的字段、文本、超链接或其他控件元素。 |
|
可选的 LabelText 元素。 要在工作项窗体上显示的信息或标签的容器元素。 有关更多信息，请参见 LabelText 和 Text XML 元素引用。 |
备注
Link 和 Content 关键字互相排斥。
AllowScript 和 ReloadOnParamChange 特性不可使用，前提是在您使用 Content 元素时。
网页控件配置为显示原始 HTML 时，将禁用所有脚本。 如果在 Visual Studio 中或在 Internet Explorer 中显示工作项表单，则会在 Visual Studio Web 浏览器中打开单击的内容中的任何超链接。
几个工具栏按钮添加到工作项表单，用于包含 WebpageControl 的选项卡。 这些选项包括以下功能：
后退和前进导航
停止内容加载和内容刷新
返回值内容主页
在新窗口中或外部浏览器中打开该内容
此外，如果要加载的网页中包含不受信任的内容则阻止图标，并且会显示被阻止的图标。
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 内容和网页链接
修订记录
Date |
修订记录 |
原因 |
|---|---|---|
|
2011 年 5 月 |
更正了 XML 语法的多个元素和特性的大小写。 跟踪工作项的架构定义将 FORM 元素的全部子元素定义为 Camel 大小写格式版本，并以全大写格式定义所有其他元素。 |
内容 Bug 修复 |
|
2011 年 1 月 |
移除了指向已移除主题的链接。 |
信息补充。 |